Installation

The installation of the package is straightforward. To prevent conflicts with other Python packages, it is recommended to create a separate Python environment. Below are the steps for installing the package using different methods.

Create a Python environment

You can create a Python environment by using the following steps through Anaconda distribution.

conda create --name <env_name>
conda activate <env_name>
conda install pip

Install from PyPI

pip install BharatFinTrack

Install from GitHub repository

pip install git+https://github.com/debpal/BharatFinTrack.git

Install from source code in editable mode

For developers who want to modify the source code or contribute to the package, it is recommended to install in editable mode. Navigate to your directory with the <env_name> Python environemnt activated, and run the following commands. This allows you to make changes to the source code, with immediate reflection in the environment without requiring reinstallation.

pip install build
git clone git+https://github.com/debpal/BharatFinTrack.git
cd BharatFinTrack
python -m build
pip install -e .