Django-ForRunners

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 )

django-for-runners_ynh allows you to install Django-ForRunners quickly and simply on a YunoHost server. If you don't have YunoHost, please consult the guide to learn how to install it.

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)

Developer information

prepare

To start hacking: Just clone the project and start ./manage.py to bootstrap a virtual environment:

# Install base requirements for bootstraping:
~$ sudo apt install python3-pip python3-venv

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

# Just call manage.py:
~/django-for-runners$ ./manage.py --help
...
[manage_django_project]
    code_style
    coverage
    install
    project_info
    publish
    run_dev_server
    safety
    tox
    update_req
...

This bootstrap is realized with: https://github.com/jedie/manage_django_project

Start Django's dev server:

~/django-for-runners$ ./manage.py run_dev_server

The web page is available in Port 8000, e.g.: http://127.0.0.1:8000/

Run tests, e.g.:

~/django-for-runners$ ./manage.py test
# or with coverage
~/django-for-runners$ ./manage.py coverage
# or via tox:
~/django-for-runners$ ./manage.py tox

import GPX files

e.g.:

~/django-for-runners$ ./manage.py 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$ ./manage.py 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

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-runners v0.4.0 2018-6-26 GPX info.png

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

print a small overview

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:

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

Make new release

We use cli-base-utilities to generate the history in this README.

To make a new release, do this:

• Increase your project version number
• Run tests to update the README
• commit the changes
• Create release

Django compatibility

(See also combinations in tox settings in pyproject.toml and github actions)

Backwards-incompatible changes

v0.16.0

We switched from Poetry to pip-tools and https://github.com/jedie/manage_django_project Just remove the old Poetry venv and bootstrap by call the ./manage.py, see above.

We also remove different Django Versions from test matrix and just use the current newest version. Because this is a project and not really a reuse-able-app ;)

history

• v0.18.0
  • 2024-08-02 - Update README.md
  • 2024-08-02 - Expand test matrix with 3.12 and remove 3.9 support
  • 2024-08-02 - Bugfix CI: Add "*.snapshot.json" files ;)
  • 2024-08-02 - Add https://pre-commit.com hook
  • 2024-08-02 - Replace "safety" by "pip-audit"
  • 2024-08-01 - Replace metaweather.com with open-meteo.com
  • 2024-08-01 - Update test_add_gpx()
  • 2024-08-01 - Update Leaflet to v1.9.4 and fix styles
  • 2024-08-01 - Support KML track import created by Pentax K-1
  • 2024-08-01 - Catch metaweather.com error
  • 2024-07-31 - Project updates
  • 2024-07-31 - Update requirements
  • 2024-01-18 - +typeguard +manageprojects updates
  • 2023-12-17 - Use cli_base.cli_tools.git_history.update_readme_history()
  • 2023-12-17 - Update requirements ; TODO: Update to Django 5.0
  • 2023-12-17 - Code style fixes
  • 2023-12-17 - Apply manageprojects updates
• v0.17.4
  • 2023-11-07 - audo generate README history
  • 2023-11-07 - Update Requirements
  • 2023-11-07 - Update UploadGpxFileForm
  • 2023-04-05 - Update to manage-django-project v0.3.0rc0
  • 2023-04-05 - Bugfixes:
  • 2023-04-04 - Switch to "managed-django-project" template:
• v0.17.3
  • 2023-04-03 - Bugfix check if Postgres is used and migration not done
• v0.17.2
  • 2023-04-02 - release 0.17.2
  • 2023-04-02 - Bugfix adding all template files

links

• Homepage: http://github.com/jedie/django-for-runners
• PyPi: https://pypi-hypernode.com/project/django-for-runners/

activity exporter

It's sometimes hard to find a working project for exporting activities. So here tools that i use currently:

• Garmin-Connect-Export from rsjrny

alternatives (OpenSource only)

• https://github.com/pytrainer/pytrainer (Desktop Program)
• https://github.com/GoldenCheetah/GoldenCheetah/ (Desktop Program)

Online tools:

• https://www.j-berkemeier.de/ShowGPX.html (de)

credits

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

• gpxpy GPX file parser
• Leaflet JS A JS library for interactive maps used to render the track on OpenStreetMap
• dygraphs open source JavaScript charting library
• Chart.js HTML5 Charts
• geopy Get geo location names of the GPX track start/end point
• matplotlib plotting 2D graphics
• autotask schedule background jobs
• svgwrite Generating SVG file

donation

• paypal.me/JensDiemer
• Flattr This!
• Send Bitcoins to 1823RZ5Md1Q2X5aSXRC5LRPcYdveCiVX6F