Installation#

Install with pip#

pip install sportslabkit

If you encounter any problems, please open an issue!

Install from development branch#

To get the latest features from the development branch:

pip install git+https://github.com/atomscott/sportslabkit.git@develop#egg=sportslabkit

Install with conda and poetry#

For development, we use a conda environment coupled with Poetry. Here’s how to set it up:

Create a conda environment:

conda env create --file dev_environment.yaml --name sportslabkit_dev_env

Activate the environment and install dependencies:

conda activate sportslabkit_dev_env
poetry install

Using Make Commands#

If you want to go beyond basic installation and run specific tasks like linting or testing, you can use the Makefile commands. Navigate to the project directory in your terminal and run the desired make command. For example:

To clean compiled Python files:
```
make clean
```
To run lint checks:
```
make lint
```
To run tests:
```
make tests
```

Refer to the Makefile for a full list of available commands.