Metadata-Version: 2.1
Name: cheetahpy
Version: 0.5.1
Summary: Python API for accessing Golden Cheetah
Author-email: Ryan Duecker <ryan.duecker@yahoo.com>
License: MIT License
        
        Copyright (c) 2022 Ryan Duecker
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: pandas
Requires-Dist: requests
Provides-Extra: testing
Requires-Dist: pytest; extra == "testing"
Provides-Extra: linting
Requires-Dist: flake8; extra == "linting"
Requires-Dist: pylint; extra == "linting"
Provides-Extra: dev
Requires-Dist: pytest; extra == "dev"
Requires-Dist: flake8; extra == "dev"
Requires-Dist: pylint; extra == "dev"

# CheetahPy
[![CodeFactor](https://www.codefactor.io/repository/github/ryanaugust/cheetahpy/badge)](https://www.codefactor.io/repository/github/ryanaugust/cheetahpy)
[![PyPI Downloads](https://img.shields.io/pypi/dm/cheetahpy.svg?label=PyPI%20downloads)](
https://pypi.org/project/cheetahpy/)

This module is used to access [Golden Cheetah](https://github.com/GoldenCheetah/GoldenCheetah) based data.
**CheetahPy_API** enables pythonic access to the GC API, allowing for programmatic access to GC rendered data.
**opendata_dataset** enables similar access and summary/activity functions for locally stored opendata project files that have been pre-compiled by GC.

------
Documentation specifically for the API can be found [here](https://github.com/GoldenCheetah/GoldenCheetah/wiki/UG_Special-Topics_REST-API-documentation). However, the basic hierarchy can be referenced below and knowledge of the API is unnecessary for using this module. Broadly the API provides no compute functionality and instead is purely desgined as a raw data retrieval pipeline.

Golden Cheetah has five key object classes: Athletes, Activities, Zones, Measures, and Meanmax.
Athlete is the node from which all others are referenced.
