Merge pull request #30 from vkurup/switch-github-actions

vkurup · web-flow · commit e1381bd809e4 · 2020-12-20T17:17:35.000-05:00
Switch GitHub actions
diff --git a/.coveragerc b/.coveragerc
@@ -1,6 +1,9 @@
 [run]
 branch = true
 source = tcxparser
+omit = */tests*
 
 [report]
+fail_under = 99
 show_missing = true
+skip_covered = true
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -0,0 +1,28 @@
+# This workflows will upload a Python Package using Twine when a release is created
+# For more information see:
+# https://help.github.com/en/actions/language-and-framework-guides/using-python-with-github-actions#publishing-to-package-registries
+
+name: Upload Python Package
+
+on:
+  release:
+    types: [created]
+
+jobs:
+  release:
+    runs-on: ubuntu-20.04
+
+    steps:
+    - uses: actions/checkout@v2
+    - uses: actions/setup-python@v2
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install setuptools wheel twine
+    - name: Build and publish
+      env:
+        TWINE_USERNAME: __token__
+        TWINE_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
+      run: |
+        python setup.py sdist bdist_wheel
+        twine upload dist/*
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -0,0 +1,46 @@
+name: lint-test
+
+on:
+  pull_request:
+  push:
+    branches:
+      - master
+  schedule:
+    # run once a week on early monday mornings
+    - cron: '22 2 * * 1'
+
+jobs:
+  pre-commit:
+    runs-on: ubuntu-20.04
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-python@v2
+      - uses: pre-commit/action@v2.0.0
+
+  tox:
+    runs-on: ubuntu-20.04
+    strategy:
+      matrix:
+        # tox-gh-actions will only run the tox environments which match the currently
+        # running python-version. See [gh-actions] in tox.ini for the mapping
+        python-version: [3.6, 3.7, 3.8, 3.9]
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v2
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Cache pip
+        uses: actions/cache@v2
+        with:
+          path: ~/.cache/pip
+          key: ${{ runner.os }}-pip-${{ hashFiles('dev-requirements.txt') }}
+          restore-keys: |
+            ${{ runner.os }}-pip-
+            ${{ runner.os }}-
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r dev-requirements.txt
+      - name: Test with tox
+        run: tox
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -0,0 +1,30 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v3.3.0
+    hooks:
+      - id: check-added-large-files
+      - id: check-case-conflict
+      - id: check-json
+      - id: check-merge-conflict
+      - id: check-symlinks
+      - id: check-yaml
+      - id: debug-statements
+      - id: detect-private-key
+      - id: end-of-file-fixer
+      - id: mixed-line-ending
+      - id: trailing-whitespace
+
+  - repo: https://github.com/psf/black
+    rev: 20.8b1
+    hooks:
+      - id: black
+
+  - repo: https://github.com/pycqa/isort
+    rev: 5.6.4
+    hooks:
+      - id: isort
+
+  - repo: https://gitlab.com/pycqa/flake8
+    rev: master
+    hooks:
+      - id: flake8
diff --git a/.python-version b/.python-version
@@ -0,0 +1,4 @@
+3.9.0
+3.8.6
+3.7.9
+3.6.12
diff --git a/.travis.yml b/.travis.yml
diff --git a/AUTHORS.rst b/AUTHORS.rst
@@ -13,5 +13,6 @@ Other contributions from:
 * Stephen Doyle (@stevedoyle)
 * Loïs Taulelle (@ltaulell)
 * Jan Pipek (@janpipek)
+* Kees Hink (@khink)
 
 Thank you!
diff --git a/CHANGES.rst b/CHANGES.rst
@@ -1,6 +1,13 @@
 CHANGES
 =======
 
+v2.0.0, 2020-12-20
+------------------
+
+* Add command to extract the percentage of workout spent in each HR zone. Thanks @khink (#29)
+* Drops support for Python 2.7
+
+
 v1.1.0, 2020-01-10
 ------------------
 
diff --git a/LICENSE b/LICENSE
@@ -1,4 +1,4 @@
-Copyright (c) 2013-2020, Vinod Kurup
+Copyright (c) 2013-2021, Vinod Kurup
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without modification,
diff --git a/MANIFEST.in b/MANIFEST.in
@@ -1,2 +1,3 @@
 include *.txt
 include *.md
+include *.rst
diff --git a/README.rst b/README.rst
@@ -1,22 +1,19 @@
 python-tcxparser
 ================
 
-.. image:: https://img.shields.io/pypi/v/python-tcxparser.svg
-    :target: https://pypi.python.org/pypi/python-tcxparser
-    :alt: Latest PyPI version
+.. sidebar:: Build Status
 
-.. image:: https://travis-ci.org/vkurup/python-tcxparser.svg?branch=master
-   :target: https://travis-ci.org/vkurup/python-tcxparser
-   :alt: Latest Travis CI build status
+   :master: |master-status|
+   :develop: |develop-status|
 
 .. image:: https://pyup.io/repos/github/vkurup/python-tcxparser/shield.svg
    :target: https://pyup.io/repos/github/vkurup/python-tcxparser/
    :alt: Requirement Updates
 
-.. image:: https://codecov.io/gh/vkurup/python-tcxparser/branch/master/graph/badge.svg
-   :target: https://codecov.io/gh/vkurup/python-tcxparser
-   :alt: Code Coverage
-
+.. |master-status| image::
+    https://github.com/vkurup/python-tcxparser/workflows/lint-test/badge.svg?branch=master
+    :alt: Build Status
+    :target: https://github.com/vkurup/python-tcxparser/actions?query=branch%3Amaster
 
 python-tcxparser is a minimal parser for Garmin's TCX file format. It
 is not in any way exhaustive. It extracts just enough data to allow me
@@ -86,6 +83,28 @@ License
 
 * BSD
 
+
+Maintainer Information
+----------------------
+
+We use Github Actions to lint (using pre-commit, black, isort, and flake8),
+test (using tox and tox-gh-actions), and calculate coverage (using coverage).
+
+We have a local script to do these actions locally, named ``maintain.sh``::
+
+  $ ./maintain.sh
+
+A Github Action workflow also builds and pushes a new package to PyPI whenever a new
+Release is created in Github. This uses a project-specific PyPI token, as described in
+the `PyPI documentation here <https://pypi.org/help/#apitoken>`_. That token has been
+saved in the ``PYPI_PASSWORD`` settings for this repo, but has not been saved anywhere
+else so if it is needed for any reason, the current one should be deleted and a new one
+generated.
+
+As always, be sure to bump the version in ``setup.py`` before creating a Release, so
+that the proper version gets pushed to PyPI.
+
+
 Contact
 -------
 
diff --git a/dev-requirements.txt b/dev-requirements.txt
@@ -0,0 +1,6 @@
+. # <- install ourselves
+coverage
+flake8
+pre-commit
+tox
+tox-gh-actions
diff --git a/maintain.sh b/maintain.sh
@@ -0,0 +1,7 @@
+#!/bin/sh
+set -ex
+
+pip install -Ur dev-requirements.txt
+pre-commit install
+pre-commit run -a
+tox
diff --git a/setup.cfg b/setup.cfg
@@ -2,4 +2,12 @@
 description-file = README.rst
 
 [flake8]
+exclude = .tox
 max-line-length = 120
+
+[bdist_wheel]
+universal = 1
+
+[isort]
+profile = black
+multi_line_output = 3
diff --git a/setup.py b/setup.py
@@ -1,31 +1,32 @@
-from setuptools import setup, find_packages
+from setuptools import find_packages, setup
 
-__version__ = '1.1.0'
+__version__ = "2.0.0"
 
 setup(
-    name='python-tcxparser',
+    name="python-tcxparser",
     version=__version__,
-    description='Simple parser for Garmin TCX files',
-    long_description=open('README.rst').read(),
-    author='Vinod Kurup',
-    author_email='vinod@kurup.com',
-    url='https://github.com/vkurup/python-tcxparser/',
-    packages=find_packages(include=['tcxparser']),
+    description="Simple parser for Garmin TCX files",
+    long_description=open("README.rst").read(),
+    author="Vinod Kurup",
+    author_email="vinod@kurup.com",
+    url="https://github.com/vkurup/python-tcxparser/",
+    packages=find_packages(include=["tcxparser"]),
     include_package_data=True,
-    license='BSD',
+    license="BSD",
     zip_safe=False,
-    keywords='tcx',
+    keywords="tcx",
     classifiers=[
-        'Development Status :: 5 - Production/Stable',
-        'Intended Audience :: Developers',
-        'License :: OSI Approved :: BSD License',
-        'Operating System :: OS Independent',
-        'Programming Language :: Python',
-        'Programming Language :: Python :: 2',
-        'Programming Language :: Python :: 2.7',
-        'Programming Language :: Python :: 3',
-        'Programming Language :: Python :: 3.6',
-        'Topic :: Software Development :: Libraries :: Python Modules',
+        "Development Status :: 5 - Production/Stable",
+        "Intended Audience :: Developers",
+        "License :: OSI Approved :: BSD License",
+        "Operating System :: OS Independent",
+        "Programming Language :: Python",
+        "Programming Language :: Python :: 3",
+        "Programming Language :: Python :: 3.6",
+        "Programming Language :: Python :: 3.7",
+        "Programming Language :: Python :: 3.8",
+        "Programming Language :: Python :: 3.9",
+        "Topic :: Software Development :: Libraries :: Python Modules",
     ],
     install_requires=[
         "lxml",
diff --git a/tcxparser/exceptions.py b/tcxparser/exceptions.py
@@ -1,10 +1,10 @@
 class TcxParserException(Exception):
     """A generic error to raise when parsing a tcx file fails"""
+
     pass
 
 
 class NoHeartRateDataError(Exception):
-
     def __init__(self):
         self.message = "The tcx file contains no heart rate data."
         super().__init__(self.message)
diff --git a/tcxparser/tcxparser.py b/tcxparser/tcxparser.py
diff --git a/tests/test_cycling.py b/tests/test_cycling.py
diff --git a/tests/test_tcxparser.py b/tests/test_tcxparser.py
diff --git a/tox.ini b/tox.ini

-Original file line number
+Diff line change
@@ @@ -0,0 +1,4 @@ @@
 +3.9.0
 +3.8.6
 +3.7.9
 +3.6.12
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-Copyright (c) 2013-2020, Vinod Kurup`
	`1`	`+Copyright (c) 2013-2021, Vinod Kurup`
`2`	`2`	`All rights reserved.`
`3`	`3`
`4`	`4`	`Redistribution and use in source and binary forms, with or without modification,`
Original file line number	Diff line number	Diff line change
`@@ -1,2 +1,3 @@`
`1`	`1`	`include *.txt`
`2`	`2`	`include *.md`
	`3`	`+include *.rst`