Development

This section outlines the steps for contributing to or building the pyETA-toolbox from source.

Clone the Repository

To begin development, clone the repository from GitHub:

git clone https://github.com/VinayIN/pyETA-toolbox.git
cd pyETA-toolbox

Change the branch from main to another branch-xyz

Changing the Version in pyproject.toml

To update the package version:

1. Open the pyproject.toml file in the project root and change the version:

name = "pyeta-toolbox"
version = "<new-version>"  # e.g., "0.0.9dev"

1. Install the pyETA package as editable

pip install -e .

1. make your changes and test the application. Steps are the same as launching the application

Creating a Package with Poetry

To build a distributable package:

1. Install Poetry if not already installed:

   pip install poetry

2. Build the package:

   poetry build

   This generates .whl and .tar.gz files in the dist/ directory.

Reporting Issues

If you encounter problems, report them on the issue tracker: https://github.com/VinayIN/pyETA-toolbox/issues and include any errors and logs in your report.