.idea | ||
controls | ||
.gitignore | ||
LICENSE | ||
pyproject.toml | ||
README.md | ||
requirements.txt |
Creating a Virtual Environment and Installing Dependencies
To set up a virtual environment for your project and install dependencies, follow these steps:
-
Install Python 3.11:
Make sure you have Python 3.11 installed on your system. You can download it from the official Python website.
-
Create a Virtual Environment:
Open your terminal or command prompt and navigate to your project directory. Then, run the following command to create a virtual environment. Replace
<venv>
with your preferred virtual environment name:python3.11 -m venv <venv>
-
** Activate the Virtual Environment:On Windows:** On Windows: .<venv>\Scripts\activate On macOS and Linux: source /bin/activate Your command prompt should now show the virtual environment name, indicating that it's active.
-
** Install Dependencies: ** Use pip to install the project's dependencies from the requirements.txt file. Replace <path_to_requirements.txt> with the actual path to your requirements.txt file: pip install -r <path_to_requirements.txt> This will install all the necessary packages for your project.
-
** Deactivate the Virtual Environment: ** This returns you to your system's global Python environment. Now you have a virtual environment set up for your project with all the required dependencies installed. You can activate it whenever you work on your project to isolate its dependencies from the system-wide Python installation.
Creating Documentation
-
** Open 'Controls' directory ** On Linux: $ cd ./memorizer/controls
-
** Open 'Controls' directory ** On Linux: $ sphinx-quickstart
-
Follow the instructions