Part 1: Building Environments

1. Prerequisites

Ensure your system meets the minimum requirements:

System Requirements

Operating System: macOS, or Windows (Linux is not tested).
Storage: Minimum 2 GB of free space for the project files
A working internet connection is needed for downloading dependencies and accessing the EDINET API.

Python Requirements

Python 3.8 or higher is required for this project.
Ensure pip, the Python package manager, is installed and updated to the latest version.

EDINET API Access

Sign up for an EDINET account
Obtain the API key
Note down the API key securely, as it will be required during configuration.

Additional Tools

Basic understanding of Window PowerShell

2. Windows PowerShell

Windows PowerShell is a command-line shell and scripting language designed for system management and automation. Think of it as a powerful tool to control and automate your computer.

This guide is tailored to help you get comfortable with navigating folders and running Python scripts in Windows PowerShell.

2.1 Open PowerShell

Press Win + S and type PowerShell, then click on Windows PowerShell to open it.
A blue or black window will appear; this is your PowerShell environment.

2.2 Navigating Folders in PowerShell

PowerShell uses commands to move between folders (directories) on your computer.

Check Current Folder

Type pwd (short for "Print Working Directory") and press Enter.
```
xxxxxxxxxx
pwd
```

Example Output:


xxxxxxxxxx
Path
----
C:\Users\YourUsername

Change Folders

Use cd (Change Directory) to navigate to another folder.

Example:


xxxxxxxxxx
cd Downloads

Now, you're inside the Downloads folder.

List Files and Folders

Use ls or Get-ChildItem to see all files and folders in the current directory.

Example


xxxxxxxxxx
ls

Output:


xxxxxxxxxx
Mode   LastWriteTime       Length Name
----   -------------       ------ ----
d----- 2023-11-29  12:00          Documents
d----- 2023-11-29  12:00          Downloads
-a---- 2023-11-29  12:00      100 example.txt

Go Back to the Previous Folder

Use cd .. to move up one level in the directory hierarchy.
Example:
```
xxxxxxxxxx
cd ..
```

2.3. Running Python Scripts in PowerShell

Verify Python Installation

Check if Python is installed by typing:
```
xxxxxxxxxx
python -V
```

If Python is installed, you’ll see a version number like Python 3.10.0.

If not, download and install Python from python.org.

Run Python in PowerShell

Example
```
xxxxxxxxxx
python
```

Output


xxxxxxxxxx
Python 3.12.3 (tags/v3.12.3:f6650f9, Apr  9 2024, 14:05:25) [MSC v.1938 64 bit (AMD64)] on win32
Type "help", "copyright", "credits" or "license" for more information.

3. Virtual Environments

3.1 What is a Virtual Environment? 🤔

A virtual environment is like a sandbox for your Python project.

It creates an isolated space where you can install and manage libraries and dependencies specific to your project without affecting the global Python setup on your computer.

Why Use It?

Different projects may need different library versions.
Avoid conflicts between project dependencies.
Keep your system’s Python clean and organized.

3.2 Setting Up a Virtual Environment 🛠️

Using venv (Recommended)

Navigate to Your Project Folder:


xxxxxxxxxx
cd /path/to/your/project

Create the Virtual Environment:
```
xxxxxxxxxx
python -m venv my_venv
```
my_venv is the name of your virtual environment folder.
You can name it anything (e.g., .env, myenv).

Activate the Virtual Environment:

On Windows:


x
my_venv/Scripts/Activate.ps1

On macOS:


xxxxxxxxxx
my_venv/bin/Activate

You’ll Notice a Change in Your Shell:
Your shell prompt will now have (my_venv) or your chosen name in front, indicating the virtual environment is active:
```
xxxxxxxxxx
(my_venv) C:\Users\YourProject>
```

3.3 Installing Libraries in the Virtual Environment 📦

Now that your virtual environment is active, you can install libraries specific to edinet-explorer

Install EDINET-EXPLORER:


xxxxxxxxxx
pip install edinet-explorer

This command installs the edinet-explorer library ONLY in the virtual environment.

Install JTEXT:


xxxxxxxxxx
pip install jext

Check Installed Libraries
```
xxxxxxxxxx
pip list
```