Skip to content

Commit

Permalink
version bump & new description referencing opendata
Browse files Browse the repository at this point in the history
  • Loading branch information
RyanAugust committed Jun 1, 2023
1 parent 840dd0e commit 58cd180
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 4 deletions.
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,11 @@
# CheetahPy
This module is used to access the locally hosted API provided by within [Golden Cheetah](https://github.com/GoldenCheetah/GoldenCheetah).
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.


3 changes: 2 additions & 1 deletion cheetahpy/__init__.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
__title__ = 'CheetahPy'
__version__ = '0.3.0'
__version__ = '0.4.0'
__author__ = 'RyanAugust'
__license__ = 'MIT'
__copyright__ = 'Copyright 2023'
Expand All @@ -16,4 +16,5 @@

__all__ = [
'CheetahPy',
'opendata_dataset'
]
4 changes: 2 additions & 2 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,10 @@

setuptools.setup(
name="cheetahpy",
version="0.3.0",
version="0.4.0",
author="Ryan Duecker",
author_email='ryan.duecker@yahoo.com',
description="Python wrapper for working with the Golden Cheetah API",
description="Python wrapper for working with the Golden Cheetah API & opendata",
extras_require={
"test": [
"pytest"]
Expand Down

0 comments on commit 58cd180

Please sign in to comment.