Skip to main content
Join the official 2020 Python Developers SurveyStart the survey!

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

Project description

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

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

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

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

dependencies are:

  • pip (Debian/Ubuntu package name: python3-pip)

Linux

Prepare: install poetry e.g.:

~$ sudo apt install python3-pip
~$ pip3 install -U pip --user
~$ pip3 install -U poerty --user

Clone the sources, e.g.:

~$ git clone https://github.com/jedie/django-for-runners.git
~$ cd django-for-runners

# install via poetry:
~/django-for-runners$ make install

# Start Django dev. server:
~/django-for-runners$ make run-dev-server

Our Makefile help, e.g.:

~/django-for-runners$ make help
help                 List all commands
install-poetry       install or update poetry
install              install django-for-runners via poetry
update               update the sources and installation
lint                 Run code formatters and linter
fix-code-style       Fix code formatting
tox-listenvs         List all tox test environments
tox                  Run pytest via tox with all environments
tox-py36             Run pytest via tox with *python v3.6*
tox-py37             Run pytest via tox with *python v3.7*
tox-py38             Run pytest via tox with *python v3.8*
pytest               Run pytest
update-rst-readme    update README.rst from README.creole
publish              Release new version to PyPi
run-dev-server       Run the django dev server in endless loop.
run-server           Run the gunicorn server in endless loop.
backup               Backup everything
create-starter       Create starter file.
recreate-files       Recreate all SVG and GPX files for all Tracks.

We have these commands:

CLI to start the web server to use Django-ForRunners, e.g.:

~/django-for-runners$ poetry run for_runners --help
Django-ForRunners v0.11.0
Usage: for_runners [OPTIONS] COMMAND [ARGS]...

Options:
  --version  Show the version and exit.
  --help     Show this message and exit.

Commands:
  backup          Backup everything
  create-starter  Create starter file.
  recreate-files  Recreate all SVG and GPX files for all Tracks.
  run-dev-server  run the django dev server in endless loop.
  run-server      Run the gunicorn server in endless loop.

Run django manage commands with Django-ForRunners project settings, e.g.:

~/django-for-runners$ poetry run manage --help
...
Type 'manage help <subcommand>' for help on a specific subcommand.

Available subcommands:
...
[for_runners]
    backup
    base
    fill_basedata
    import_gpx
    recreate_files

[for_runners_helper_app]
    run_server
...

Windows

TODO: Create shortcut (via pywin32?) TODO: Update the old boot cmd file

import GPX files

e.g.:

~/django-for-runners$ poetry run manage import_gpx --username <django_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.

backup

Create a backup into .../backups/<timestamp>/ e.g.:

~/django-for-runners$ poetry run for_runners backup

The backup does:

  • backup the database
  • export all GPX tracks
  • generate .csv files:
  • a complete file with all running tracks
  • one file for every user

regenerate all SVG files

~/django-for-runners$ poetry run for_runners recreate-svg

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

~/Django-ForRunners$ make test

or:

~/Django-ForRunners$ make 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.11.0 2.2.x LTS 3.6, 3.7, 3.8
>=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.11.0…master dev

    • tbc
  • 04.07.2020 - v0.11.0:

    • refactor gpx import code
    • update tests
    • Use poetry and add Makefile
    • update code style
  • 09.08.2019 - v0.10.1:

    • Enhance “Event Participation” admin view: Add start date and costs in table
  • 26.06.2019 - v0.10.0:

    • NEW: GPX Admin action to print a small overview from one or a few tracks
    • Accept optional server bind address, e.g.: for_runners run-server 127.0.0.1:8080
  • 02.04.2019 - v0.9.0:

    • NEW: Update complete environment installation with: for_runners update

    • Move the SQlite database to virtualenv root dir, e.g.: ~/Django-ForRunners/Django-ForRunners-database.sqlite3

    • NEW: save every gpx track to disk

    • NEW: Backup/export via cli: $ for_runners backup

    • NEW: export GPX Data via django-import-export

    • Create xdg-open desktop starter under linux here: ~/Django-ForRunners/Django-ForRunners

    • refactor the startup process:

      • auto loop the server process
      • open web browser on first start
      • enable autotask
    • rename for_runners_test_project to for_runners_project

  • 03.09.2018 - v0.8.1:

    • Fix “try-out” section in README, again ;(
  • 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


Note: this file is generated from README.creole 2020-07-04 19:49:40 with "python-creole"

Project details


Download files

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

Files for django-for-runners, version 0.11.0
Filename, size File type Python version Upload date Hashes
Filename, size django_for_runners-0.11.0-py3-none-any.whl (912.7 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size django-for-runners-0.11.0.tar.gz (870.1 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page