Welcome to the NFS Resources Converter project! To ensure smooth, reproducible, and error-free development, please follow these guidelines carefully.
- Python Version: This project uses Python 3.14.
- Virtual Environment: All dependencies must be managed within a virtual environment located at
./.venvin the project root.
-
Activation of Virtual Environment:
- If the
.venvdirectory already exists, always activate it before launching any Python scripts or commands:- On macOS/Linux:
source .venv/bin/activateor invoke Python explicitly using./.venv/bin/python - On Windows:
.venv\Scripts\activateor invoke Python explicitly using.\.venv\Scripts\python
- On macOS/Linux:
- If the
-
Environment Initialization:
- If the
.venvdirectory does not exist, you must create it once:python3.14 -m venv .venv
- After creation, activate the virtual environment and install the required packages listed in
requirements.txt:./.venv/bin/pip install -r requirements.txt
- If the
-
Running Code & Tests:
- Always run the test suite and application code through the virtual environment Python interpreter. For example:
./.venv/bin/python -m unittest
- Always run the test suite and application code through the virtual environment Python interpreter. For example: