chironpy 0.28.0

Workout analysis

chironpy

Endurance sports analysis library for Python

A fork of sweatpy

: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.

Documentation

Usage and examples can be found here.

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:

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.