Skip to main content

Store your GPX tracks of your running (or other sports activity) in django.

Project description

Store your GPX tracks of your running (or other sports activity) in django.

The name Django-ForRunners has the origin from the great Android tracking app ForRunners by Benoît Hervier: http://rvier.fr/#forrunners

Build Status on travis-ci.org

travis-ci.org/jedie/django-for-runners

Coverage Status on codecov.io

codecov.io/gh/jedie/django-for-runners

Coverage Status on coveralls.io

coveralls.io/r/jedie/django-for-runners

Status on landscape.io

landscape.io/github/jedie/django-for-runners/master

Features:

  • GPX track management:

    • Upload GPX tracks

    • Import GPX tracks from commandline

    • Track analysis:

      • basics: Track length / Duration / Pace / Hart rate Up-/Downhill

      • Display route on OpenStreetMap map

      • Graphs with elevation / heart rate / cadence (if available in GPX data)

    • Data that is automatically extracted from the web:

      • Start/finish Address from OpenStreetMap

      • Start/finish weather information from metaweather.com

    • Store additional data:

      • Ideal track distance (for easier grouping/filtering tracks)

  • sports competitions Management:

    • Create a List of Sport Events

      • Add participation to a event

      • link GPX track with a event participation

      • Store you event participation:

        • official track length

        • measured finisher time

        • Number of participants who have finished in your discipline

      • Add links to webpages relatet to this event

      • Record costs (entry fee, T-shirt etc.)

  • common

    • Multiple user support (However: no rights management and currently only suitable for a handful of users)

try-out

Just:

  1. Download the file boot_django_for_runners.sh

  2. run boot_django_for_runners.sh

e.g.:

~$ curl https://raw.githubusercontent.com/jedie/django-for-runners/master/boot_django_for_runners.sh -o boot_django_for_runners.sh
~$ chmod +x boot_django_for_runners.sh
~$ ./boot_django_for_runners.sh

The shell script creates a python virtual environment and install all needed requirements in you home directory, here:

  • ~/Django-ForRunners

The setup routine will install two commands:

  • ~/Django-ForRunners/bin/run_dev_server - Start the web server to use Django-ForRunners

  • ~/Django-ForRunners/bin/manage - Run django manage commands with Django-ForRunners settings

start the development server with the test project, e.g.:

~$ ~/DjangoForRunnersEnv/bin/run_dev_server

You can also just double click on ~/Django-ForRunners/bin/run_dev_server in your file manage ;)

import GPX files

e.g.:

~$ ~/Django-ForRunners/bin/manage import_gpx --username <username> ~/backups/gpx_files

Note: It is no problem to start import_gpx with the same GPX files: Duplicate entries are avoided. The start/finish (time/latitude/longitude) are compared.

Screenshots

(All screenshots are here: github.com/jedie/jedie.github.io/tree/master/screenshots/django-for-runners)

for-runers v0.6.0 2018-07-31 GPX Track.png

for-runers v0.6.0 2018-07-31 GPX Track.png

for-runners v0.4.0 2018-6-26 GPX info.png

for-runners v0.4.0 2018-6-26 GPX info.png

for-runners v0.6.0 2018-07-19 Event Costs.png

for-runners v0.6.0 2018-07-19 Event Costs.png

run tests

# activate the virtualenv:
~$ cd DjangoForRunnersEnv/
~/DjangoForRunnersEnv$ source bin/activate

# run the tests:
(DjangoForRunnersEnv) ~/DjangoForRunnersEnv$ cd src/django-for-runners/
(DjangoForRunnersEnv) ~/DjangoForRunnersEnv/src/django-for-runners$ ./setup.py test

# run text via tox:
(DjangoForRunnersEnv) ~/DjangoForRunnersEnv/src/django-for-runners$ ./setup.py tox

Note:

To run all tests, you need:

  • Chromium Browser WebDriver e.g.: apt install chromium-chromedriver

  • Firefox Browser WebDriver aka geckodriver

install geckodriver e.g.:

~$ cd /tmp
/tmp$ wget https://github.com/mozilla/geckodriver/releases/download/v0.20.1/geckodriver-v0.20.1-linux64.tar.gz -O geckodriver.tar.gz
/tmp$ sudo sh -c 'tar -x geckodriver -zf geckodriver.tar.gz -O > /usr/bin/geckodriver'
/tmp$ sudo chmod +x /usr/bin/geckodriver
/tmp$ rm geckodriver.tar.gz
/tmp$ geckodriver --version
geckodriver 0.20.1
...

some notes

GPX storage

Currently we store the unchanged GPX data in a TextField.

static files

We collect some JavaScript files, for easier startup. These files are:

Project Homepage

License

storage directory

leafletjs.com

Leaflet licensed under BSD

for_runners/static/leaflet/

dygraphs.com

dygraphs licensed under MIT

for_runners/static/dygraphs/

chartjs.org

Chart.js licensed under MIT

for_runners/static/chartjs/

Precision of coordinates

GPX files from Garmin (can) contain:

  • latitude with 29 decimal places

  • longitude with 28 decimal places

  • elevation with 19 decimal places

The route on OpenStreetMap does not look more detailed, with more than 5 decimal places.

See also: https://wiki.openstreetmap.org/wiki/Precision_of_coordinates

Django compatibility

django-for-runners

django version

python

>=v0.7.1

2.1

3.5, 3.6, 3.7

v0.5.x

2.0

3.5, 3.6, 3.7

(See also combinations in .travis.yml and tox.ini)

history

  • compare v0.8.0…master dev

    • TBD

  • 03.09.2018 - v0.8.0:

    • NEW: shell script for easier boot/install, see above

  • 02.09.2018 - v0.7.1:

    • Update to Django 2.1

    • Bugfix Tests

  • 02.09.2018 - v0.7.0:

    • Use dygraphs in GPX Track change admin view

    • Sync mouse over from Elevation/Headrate/Cadence dygraphs to leaflet open streep map

    • Fix “try-out” section in README (Thanks adsworth for reporting

    • Add links from gpx tracks to other admin change view

    • Bugfixes

    • internals:

      • refactor stuff around track duration/length

      • move manipluation of list_display and list_filter contributed by adsworth

  • 19.07.2018 - v0.6.0:

    • NEW: event participation

    • NEW: costs of event participation (e.g.: entry fee for the competition, cost of a T-Shirt etc.)

    • NEW: Display statistics of events/costs per user and total

  • 04.07.2018 - v0.5.0:

    • remove Django-CMS

    • update to Django v2.0

    • NOTE: The migrations are simply replaced! So you must delete your database, e.g.: src/django-for-runners$ rm test_project_db.sqlite3

    • Add ‘net duration’ field, for the officially measured time and use it for calculations if available.

    • Create django manage command to fill some base data: $ ./manage.py fill_basedata

    • speedup by deactivating some django debug toolbar panels

  • 26.06.2018 - v0.4.0:

    • combine track filters with statistic views

    • NEW: GPX info (See length, point count and Average distance in meters between the points)

    • NEW: Display GPX metadata

    • Add ‘creator’ to every track and use it as changelist filter

    • remove Streetmap image generated via geotiler

    • Speedup by using a cache for gpxpy instances

  • 23.06.2018 - v0.3.0:

    • Start adding statistics (See screenshot above)

    • add weather information from metaweather.com to every track

  • 21.06.2018 - v0.2.0:

    • Display elevations, heart_rates and cadence_values if available

    • Add kilometer markers to OpenStreetMap

  • 15.06.2018 - v0.1.1:

    • a few bugfixes

  • 15.06.2018 - v0.1.0:

    • Render interactive OpenStreetMap track map with Leaflet JS

  • 12.06.2018 - v0.0.4:

    • Better Events model

    • GPX error handling

    • more tests

    • Bugfix for Python 3.5 (Geotiler needs Python 3.6 or later)

  • 12.06.2018 - v0.0.3:

    • display min/average/max heart rate

    • use autotask to generate the MAP in background

  • 31.05.2018 - v0.0.2:

    • generate SVG ‘icon’ from GPX track

  • v0.0.1 - 30.05.2018

    • Just create a pre-alpha release to save the PyPi package name ;)

credits

The whole thing is based on many excellent projects. Especially the following:

donation

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

django-for-runners-0.8.0.tar.gz (427.6 kB view hashes)

Uploaded Source

Built Distributions

django_for_runners-0.8.0-py3.6.egg (436.0 kB view hashes)

Uploaded Source

django_for_runners-0.8.0-py2.py3-none-any.whl (439.5 kB view hashes)

Uploaded Python 2 Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page