From 10279ec0c006187698bec3a67af2bb78ef8e12cc Mon Sep 17 00:00:00 2001 From: Vinod Kurup Date: Fri, 27 Apr 2018 18:42:34 -0400 Subject: [PATCH] Prepare for release --- AUTHORS.rst | 15 +++++++++++++ AUTHORS.txt | 12 ----------- CHANGES.rst | 47 +++++++++++++++++++++++++++++++++++++++++ CHANGES.txt | 11 ---------- LICENSE.txt => LICENSE | 2 +- README.md => README.rst | 41 +++++++++++++++++++++++++++++------ setup.cfg | 2 +- setup.py | 2 +- 8 files changed, 100 insertions(+), 32 deletions(-) create mode 100644 AUTHORS.rst delete mode 100644 AUTHORS.txt create mode 100644 CHANGES.rst delete mode 100644 CHANGES.txt rename LICENSE.txt => LICENSE (97%) rename README.md => README.rst (66%) diff --git a/AUTHORS.rst b/AUTHORS.rst new file mode 100644 index 0000000..4635298 --- /dev/null +++ b/AUTHORS.rst @@ -0,0 +1,15 @@ +Primary author: +--------------- + +* Vinod Kurup (@vkurup) + + +Other contributions from: +------------------------- + +* Iztok Fister Jr (@firefly-cpp) +* Jason M. (@DaddyTheRunner) +* Adam Neumann (@noizwaves) +* Stephen Doyle (@stevedoyle) + +Thank you! diff --git a/AUTHORS.txt b/AUTHORS.txt deleted file mode 100644 index 9ab499c..0000000 --- a/AUTHORS.txt +++ /dev/null @@ -1,12 +0,0 @@ -Primary author: - -Vinod Kurup (@vkurup) - -Other contributions from: - -Iztok Fister Jr (@firefly-cpp) -Jason M. (@DaddyTheRunner) -Adam Neumann (@noizwaves) -Stephen Doyle (@stevedoyle) - -Thank you! diff --git a/CHANGES.rst b/CHANGES.rst new file mode 100644 index 0000000..eeb6eec --- /dev/null +++ b/CHANGES.rst @@ -0,0 +1,47 @@ +CHANGES +======= + +v0.8.0, 2018-04-27 +------------------ + +* Add coverage, flake8 +* Support Python 3 +* Move code into its own package +* Add some cycling support (#16) +* Run tests on CI using tox-travis + + +v0.7.2, 2017-03-02 +------------------ + +* Don't fail if lat/lon not present. + + +v0.7.1, 2016-08-14 +------------------ + +* Fix for tracks with only 1 trackpoint. + + +v0.7.0, 2016-01-01 +------------------ + +* Added average altitude support. Thanks @firefly-cpp + + +v0.6.0, 2014-11-18 +------------------ + +* Added heart rate data & pace support. Thanks @stevedoyle + + +v0.3.0, 2013-01-09 +------------------ + +* Changed methods to properties + + +v0.1.0, 2013-01-07 +------------------ + +* Initial release. diff --git a/CHANGES.txt b/CHANGES.txt deleted file mode 100644 index 8b831e0..0000000 --- a/CHANGES.txt +++ /dev/null @@ -1,11 +0,0 @@ -v0.7.1, 2017-03-02 -- Don't fail if lat/lon not present. - -v0.7.1, 2016-08-14 -- Fix for tracks with only 1 trackpoint. - -v0.7.0, 2016-01-01 -- Added average altitude support. Thanks @firefly-cpp - -v0.6.0, 2014-11-18 -- Added heart rate data & pace support. Thanks @stevedoyle - -v0.3.0, 2013-01-09 -- Changed methods to properties - -v0.1.0, 2013-01-07 -- Initial release. diff --git a/LICENSE.txt b/LICENSE similarity index 97% rename from LICENSE.txt rename to LICENSE index 53d1cdd..af273dd 100644 --- a/LICENSE.txt +++ b/LICENSE @@ -1,4 +1,4 @@ -Copyright (c) 2013-6, Vinod Kurup +Copyright (c) 2013-8, Vinod Kurup All rights reserved. Redistribution and use in source and binary forms, with or without modification, diff --git a/README.md b/README.rst similarity index 66% rename from README.md rename to README.rst index b0a346a..d263460 100644 --- a/README.md +++ b/README.rst @@ -1,6 +1,17 @@ -# python-tcxparser +python-tcxparser +================ -[![Build Status](https://travis-ci.org/vkurup/python-tcxparser.svg?branch=master)](https://travis-ci.org/vkurup/python-tcxparser) +.. image:: https://img.shields.io/pypi/v/python-tcxparser.svg + :target: https://pypi.python.org/pypi/python-tcxparser + :alt: Latest PyPI version + +.. 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 + +.. image:: https://pyup.io/repos/github/vkurup/python-tcxparser/shield.svg + :target: https://pyup.io/repos/github/vkurup/python-tcxparser/ + :alt: Updates 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 @@ -21,11 +32,17 @@ Data extracted: - max and min altitude - time stamp of each data point (in ISO UTC) -## Installation +Installation +------------ + +Install it from PyPI:: - pip install python-tcxparser + pip install python-tcxparser -## Usage +Usage +----- + +Basic usage example:: >>> import tcxparser >>> tcx = tcxparser.TCXParser('/home/vinod/Downloads/20121226-212953.tcx') @@ -51,5 +68,17 @@ Data extracted: ... tcx.calories 379 -## Contact +Compatibility +------------- + +* Python 2.7 or 3.5+ + +License +------- + +BSD + +Contact +------- + Please contact me with any questions: Vinod Kurup (vinod@kurup.com) diff --git a/setup.cfg b/setup.cfg index e91ee50..12cf9b2 100644 --- a/setup.cfg +++ b/setup.cfg @@ -1,5 +1,5 @@ [metadata] -description-file = README.md +description-file = README.rst [flake8] max-line-length = 120 diff --git a/setup.py b/setup.py index 1230b16..4fac4f4 100644 --- a/setup.py +++ b/setup.py @@ -1,6 +1,6 @@ from setuptools import setup, find_packages -__version__ = '0.7.2' +__version__ = '0.8.0' setup( name='python-tcxparser',