🏗️ Project Structure (For Contributors)

Interested in exploring the code or contributing to the framework? This repository follows modern Python packaging standards to make development as straightforward as possible.

Here is a map of the key directories and files:

/jingongo/
│
├── pyproject.toml          # The heart of the project: defines metadata and dependencies.
│
├── src/
│   └── jingongo/           # The actual Python package source code that users will import.
│
├── examples/               # Standalone scripts that demonstrate how to use the library.
│
└── tests/                  # The automated test suite (using pytest) to ensure code quality.

⚙️ How to Contribute

We welcome and appreciate all contributions! To get started, you'll want to set up a local development environment.

Step 1: Clone the Repository

First, clone the repository to your local machine and navigate into the project directory.

git clone https://github.com/vcussei/jingongo.git
cd jingongo

Step 2: Create and Activate a Virtual Environment It is highly recommended to work within a Python virtual environment to avoid conflicts with other projects.

First, create the environment

python -m venv venv

Next, activate it using the command for your operating system:

On Windows (CMD or PowerShell):

venv\Scripts\activate

On macOS or Linux:

source venv/bin/activate

Your terminal prompt should now be prefixed with (venv).

Step 3: Install Dependencies in Editable Mode Install the project in "editable" mode (-e). This is a powerful command that links the installed package directly to your source code, so any changes you make in the src/ directory are immediately reflected without needing to reinstall. The [test] part also installs the testing libraries (like pytest) specified in pyproject.toml.

pip install -e .[test]

Step 4: Run the Tests To ensure everything is set up correctly, run the automated test suite.

pytest

If all tests pass, you are ready to start developing! You can now make changes to the code in the src/jingongo/ directory and test them by running your examples or writing new tests.