Metadata-Version: 2.3
Name: chironpy
Version: 0.28.0
Summary: Workout analysis
License: MIT
Author: Clive Gross
Author-email: clive@chironapp.com
Requires-Python: >=3.10,<4.0.0
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Requires-Dist: fitparse (>=1.1.0,<2.0.0)
Requires-Dist: lmfit (>=1.0.0,<2.0.0)
Requires-Dist: matplotlib (>=3.3.4,<4.0.0)
Requires-Dist: mkdocs-material[icons] (>=9.6.12,<10.0.0)
Requires-Dist: numpy (>=1.21,<1.24)
Requires-Dist: pandas (>=1.5.2,<2.0.0)
Requires-Dist: pydantic (>=2.0,<3.0)
Requires-Dist: pyyaml (>=6.0.0,<7.0.0)
Requires-Dist: requests (>=2.23.0,<3.0.0)
Requires-Dist: scikit-learn (>=0.23.1)
Requires-Dist: scipy (>=1.4.1,<2.0.0)
Requires-Dist: stravalib (>=2.0.0,<3.0.0)
Project-URL: Documentation, https://github.com/chironapp/chironpy
Project-URL: Homepage, https://github.com/chironapp/chironpy
Project-URL: Repository, https://github.com/chironapp/chironpy
Description-Content-Type: text/markdown

# chironpy

Endurance sports analysis library for Python

A fork of [sweatpy](https://github.com/GoldenCheetah/sweatpy)

[![Downloads](https://pepy.tech/badge/chiron)](https://pepy.tech/project/chiron)

> :warning: **This is a fork of the original sweatpy project, which no longer seems to be maintained.**

Documentation for the original project can be found [here](https://github.com/GoldenCheetah/sweatpy/blob/master/docs/docs/index.md).

## Documentation

Usage and examples can be found [here](https://chironapp.github.io/chironpy/).

## Publishing

Build and publish using `poetry`.

### TestPyPI

Test using TestPyPI. Create a project-scoped token in TestPyPI. Test publish manually:

```
poetry config repositories.testpypi https://test.pypi.org/legacy/
poetry publish --repository testpypi --username __token__ --password pypi-YOURTOKEN
```

Or use the Github Actions as configured in `.github/workflows/publishtestpypi.yml`. Ensure:

- The GitHub repo is connected to the TestPyPI project in TestPyPI.
- The TestPyPI token has been added to the Github repo nvironment secrets: Settings > Environments > testpypi > Envionment secrets > TESTPYPI_TOKEN

```
[testpypi]
  repository = https://test.pypi.org/legacy/
  username = __token__
  password = # either a user-scoped token or a project-scoped token you want to set as the default
```

Install from TestPyPI:

```
pip install chironpy --index-url https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple/
```

## Development

### Validating Functionality with Scripts

The `scripts/` directory contains utility scripts to help validate the functionality of the `chironpy` library during development. Below are some examples of how to use these scripts:

#### 1. **Load any activity**

Use the `load_files.py` script to load and parse a `.fit`, `.gpx`, locally saved Strava `.json` file etc. Example files are provided in `chironpy/examples/data`.

**Usage**:

```bash
python scripts/load_fit_file.py path/to/your/file.fit

## Contributors

- [Clive Gross](https://github.com/clivegross)
- [Maksym Sladkov](https://github.com/sladkovm) - Original Author (sweatpy)
- [Aart Goossens](https://github.com/AartGoossens) - Original Author (sweatpy)

Credit to [Aaron Schroeder](https://github.com/aaron-schroeder) for tools for running power and elevation metrics published in [heartandsole](https://github.com/aaron-schroeder/heartandsole) and [spatialfriend](https://github.com/aaron-schroeder/spatialfriend).

## License

See [LICENSE](LICENSE) file.
```

