Merge pull request #42 from corriporai/develop

DOC:Updated docs to support the new release 0.4
corriporai · Apr 23, 2021 · 53647b5 · 53647b5
2 parents 5faff9b + 0766bad
commit 53647b5
Show file tree

Hide file tree

Showing 18 changed files with 290 additions and 18 deletions.
diff --git a/.github/workflows/upload-to-pypi.yml b/.github/workflows/upload-to-pypi.yml
@@ -4,8 +4,9 @@
 name: Upload Python Package
 
 on:
-  release:
-    types: [published]
+  push:
+    tags:
+      - "v*"
 
 jobs:
   deploy:
@@ -36,4 +37,29 @@ jobs:
       uses: pypa/gh-action-pypi-publish@master
       with:
         user: __token__
-        password: ${{ secrets.PYPI_API_TOKEN }}
+        password: ${{ secrets.PYPI_API_TOKEN }}
+    - name: Create GitHub Release
+      id: create_release
+      uses: actions/create-release@v1
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # This token is provided by Actions, you do not need to create your own token
+      with:
+        tag_name: ${{ github.ref }}
+        release_name: ${{ github.ref }}
+        draft: true
+        prerelease: false
+    - name: Get Asset name
+      run: |
+        export PKG=$(ls dist/ | grep tar)
+        set -- $PKG
+        echo "name=$1" >> $GITHUB_ENV
+    - name: Upload Release Asset (sdist) to GitHub
+      id: upload-release-asset
+      uses: actions/upload-release-asset@v1
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      with:
+        upload_url: ${{ steps.create_release.outputs.upload_url }}
+        asset_path: dist/${{ env.name }}
+        asset_name: ${{ env.name }}
+        asset_content_type: application/zip
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -7,4 +7,5 @@ For full details see the commit logs at https://github.com/corriporai/runpandas.
 
 .. include:: docs/source/whatsnew/v0.1.0.txt
 .. include:: docs/source/whatsnew/v0.2.0.txt
-.. include:: docs/source/whatsnew/v0.3.0.txt
+.. include:: docs/source/whatsnew/v0.3.0.txt
+.. include:: docs/source/whatsnew/v0.4.0.txt
diff --git a/docs/source/_version.txt b/docs/source/_version.txt
@@ -1 +1 @@
-Version: **0.2.0 (+18, 23d03a8)** Date: **March 13, 2021**
+Version: **0.2.0 (+52, 2dfa56e)** Date: **April 23, 2021**
diff --git a/docs/source/getting_started.rst b/docs/source/getting_started.rst
@@ -32,6 +32,8 @@ RunPandas depends on the following packages:
 - ``fitparse``
 - ``stravalib``
 - ``haversine``
+- ``pydantic``
+- ``pyaml``
 
 ^^^^^^^^^^^^^^^^^^^^^
 Detailed instructions

diff --git a/docs/source/reference/acessors.rst b/docs/source/reference/acessors.rst
@@ -22,4 +22,7 @@ Metrics
 
    metrics.MetricsAcessor
    metrics.MetricsAcessor.speed
-   metrics.MetricsAcessor.distance
+   metrics.MetricsAcessor.distance
+   metrics.MetricsAcessor.vertical_speed
+   metrics.MetricsAcessor.gradient
+   metrics.MetricsAcessor.pace
diff --git a/docs/source/reference/api/runpandas.activity_examples.rst b/docs/source/reference/api/runpandas.activity_examples.rst
@@ -0,0 +1,6 @@
+runpandas.activity\_examples
+============================
+
+.. currentmodule:: runpandas
+
+.. autofunction:: activity_examples
diff --git a/docs/source/reference/api/runpandas.types.Activity.rst b/docs/source/reference/api/runpandas.types.Activity.rst
@@ -105,6 +105,10 @@ runpandas.types.Activity
       ~Activity.mask
       ~Activity.max
       ~Activity.mean
+      ~Activity.mean_cadence
+      ~Activity.mean_heart_rate
+      ~Activity.mean_pace
+      ~Activity.mean_speed
       ~Activity.median
       ~Activity.melt
       ~Activity.memory_usage

diff --git a/...urce/reference/api/runpandas.types.acessors.metrics.MetricsAcessor.gradient.rst b/...urce/reference/api/runpandas.types.acessors.metrics.MetricsAcessor.gradient.rst
@@ -0,0 +1,6 @@
+runpandas.types.acessors.metrics.MetricsAcessor.gradient
+========================================================
+
+.. currentmodule:: runpandas.types.acessors.metrics
+
+.. automethod:: MetricsAcessor.gradient
diff --git a/docs/source/reference/api/runpandas.types.acessors.metrics.MetricsAcessor.pace.rst b/docs/source/reference/api/runpandas.types.acessors.metrics.MetricsAcessor.pace.rst
@@ -0,0 +1,6 @@
+runpandas.types.acessors.metrics.MetricsAcessor.pace
+====================================================
+
+.. currentmodule:: runpandas.types.acessors.metrics
+
+.. automethod:: MetricsAcessor.pace
diff --git a/docs/source/reference/api/runpandas.types.acessors.metrics.MetricsAcessor.rst b/docs/source/reference/api/runpandas.types.acessors.metrics.MetricsAcessor.rst
@@ -15,7 +15,10 @@ runpandas.types.acessors.metrics.MetricsAcessor
 
       ~MetricsAcessor.__init__
       ~MetricsAcessor.distance
+      ~MetricsAcessor.gradient
+      ~MetricsAcessor.pace
       ~MetricsAcessor.speed
+      ~MetricsAcessor.vertical_speed
 
 
 

diff --git a/...eference/api/runpandas.types.acessors.metrics.MetricsAcessor.vertical_speed.rst b/...eference/api/runpandas.types.acessors.metrics.MetricsAcessor.vertical_speed.rst
@@ -0,0 +1,6 @@
+runpandas.types.acessors.metrics.MetricsAcessor.vertical\_speed
+===============================================================
+
+.. currentmodule:: runpandas.types.acessors.metrics
+
+.. automethod:: MetricsAcessor.vertical_speed
diff --git a/docs/source/reference/columns.rst b/docs/source/reference/columns.rst
@@ -13,36 +13,48 @@ provides additional methods related to the measure evaluated.
 
 .. autoclass:: Altitude
    :members:
+   :undoc-members:
 
 .. autoclass:: Cadence
    :members:
+   :undoc-members:
 
 .. autoclass:: DistancePerPosition
    :members:
+   :undoc-members:
 
 .. autoclass:: Distance
    :members:
+   :undoc-members:
 
 .. autoclass:: HeartRate
    :members:
+   :undoc-members:
 
 .. autoclass:: LonLat
    :members:
+   :undoc-members:
 
 .. autoclass:: Longitude
    :members:
+   :undoc-members:
 
 .. autoclass:: Latitude
    :members:
+   :undoc-members:
 
 .. autoclass:: Pace
    :members:
+   :undoc-members:
 
 .. autoclass:: Power
    :members:
+   :undoc-members:
 
 .. autoclass:: Speed
    :members:
+   :undoc-members:
 
 .. autoclass:: Temperature
-   :members:
+   :members:
+   :undoc-members:
diff --git a/docs/source/reference/datasets.rst b/docs/source/reference/datasets.rst
@@ -0,0 +1,16 @@
+.. _datasets:
+
+========
+Datasets
+========
+
+Special functions for loading activity examples for testing purposes and demonstrations.
+
+
+.. currentmodule:: runpandas
+
+.. autosummary::
+   :toctree: api/
+
+   activity_examples
+
diff --git a/docs/source/reference/reference.rst b/docs/source/reference/reference.rst
@@ -12,5 +12,6 @@ Reference
   MeasureSeries <columns>
   Acessors <acessors>
   Input/output <io>
+  Datasets <datasets>
   Tools <tools>
   Testing <testing>