diff --git a/CHANGELOG.md b/CHANGELOG.md index 7f083a66..ea3214dd 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,22 @@ # Change log +## Version 0.5.6 (2022/02/05) + +### Issues Closed + +#### Bugs Fixed + +* [#146](https://github.com/SamR1/FitTrackee/issues/146) - incorrect label on workouts filters + +### Pull Requests + +* [#145](https://github.com/SamR1/FitTrackee/pull/145) - fix on database models + + +In this release 1 issue was closed. +**Note:** This release contains database migration (see upgrade instructions in [documentation](https://samr1.github.io/FitTrackee/installation.html#upgrade)) + + ## Version 0.5.5 (2022/01/19) ### Issues Closed diff --git a/Makefile b/Makefile index 4b950ff5..5ef48d89 100644 --- a/Makefile +++ b/Makefile @@ -16,6 +16,7 @@ check-python: lint-python type-check test-python clean: rm -rf .mypy_cache rm -rf .pytest_cache + rm -rf e2e/.pytest_cache clean-install: clean rm -fr $(NODE_MODULES) diff --git a/VERSION b/VERSION index d1d899fa..b49b2533 100644 --- a/VERSION +++ b/VERSION @@ -1 +1 @@ -0.5.5 +0.5.6 diff --git a/docs/.buildinfo b/docs/.buildinfo index ae2a0081..83e8c70e 100644 --- a/docs/.buildinfo +++ b/docs/.buildinfo @@ -1,4 +1,4 @@ # Sphinx build info version 1 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. -config: 9de908b6aff9f654d3afda99374c317e +config: 07e52347d325bc590b4a2ded72b46e83 tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/docs/_images/fittrackee_screenshot-01.png b/docs/_images/fittrackee_screenshot-01.png index 49e0d74a..ef114f7a 100644 Binary files a/docs/_images/fittrackee_screenshot-01.png and b/docs/_images/fittrackee_screenshot-01.png differ diff --git a/docs/_images/fittrackee_screenshot-02.png b/docs/_images/fittrackee_screenshot-02.png index 6423fe1b..113b0c6e 100644 Binary files a/docs/_images/fittrackee_screenshot-02.png and b/docs/_images/fittrackee_screenshot-02.png differ diff --git a/docs/_images/fittrackee_screenshot-03.png b/docs/_images/fittrackee_screenshot-03.png index 210f2721..ce4ccf87 100644 Binary files a/docs/_images/fittrackee_screenshot-03.png and b/docs/_images/fittrackee_screenshot-03.png differ diff --git a/docs/_images/fittrackee_screenshot-04.png b/docs/_images/fittrackee_screenshot-04.png index 3bdd2cce..1f691419 100644 Binary files a/docs/_images/fittrackee_screenshot-04.png and b/docs/_images/fittrackee_screenshot-04.png differ diff --git a/docs/_images/fittrackee_screenshot-05.png b/docs/_images/fittrackee_screenshot-05.png index 9c6e3509..c05a3882 100644 Binary files a/docs/_images/fittrackee_screenshot-05.png and b/docs/_images/fittrackee_screenshot-05.png differ diff --git a/docs/_images/fittrackee_screenshot-06.png b/docs/_images/fittrackee_screenshot-06.png index 60d0c009..aa268344 100644 Binary files a/docs/_images/fittrackee_screenshot-06.png and b/docs/_images/fittrackee_screenshot-06.png differ diff --git a/docs/_sources/changelog.md.txt b/docs/_sources/changelog.md.txt index 7f083a66..ea3214dd 100644 --- a/docs/_sources/changelog.md.txt +++ b/docs/_sources/changelog.md.txt @@ -1,5 +1,22 @@ # Change log +## Version 0.5.6 (2022/02/05) + +### Issues Closed + +#### Bugs Fixed + +* [#146](https://github.com/SamR1/FitTrackee/issues/146) - incorrect label on workouts filters + +### Pull Requests + +* [#145](https://github.com/SamR1/FitTrackee/pull/145) - fix on database models + + +In this release 1 issue was closed. +**Note:** This release contains database migration (see upgrade instructions in [documentation](https://samr1.github.io/FitTrackee/installation.html#upgrade)) + + ## Version 0.5.5 (2022/01/19) ### Issues Closed diff --git a/docs/_sources/features.rst.txt b/docs/_sources/features.rst.txt index 644f7309..e013b0bd 100644 --- a/docs/_sources/features.rst.txt +++ b/docs/_sources/features.rst.txt @@ -1,54 +1,6 @@ Features ######## -List -~~~~ - -Administration -^^^^^^^^^^^^^^ -(*new in 0.3.0*) - -- **Application** - - The following parameters can be set: - - - active users limit. If 0, registration is enabled (no limit defined) - - maximum size of uploaded files - - maximum size of zip archive - - maximum number of files in the zip archive. If an archive contains more files, only the configured number of files is processed, without raising errors. - - .. warning:: - Updating server configuration may be necessary to handle large files (like `nginx `_ for instance). - - -- **Users** - - - display users list and details - - edit a user to add/remove administration rights - - delete a user - -- **Sports** - - - enable or disable a sport (a sport can be disabled even if workout with this sport exists) - -Account & preferences -^^^^^^^^^^^^^^^^^^^^^ -- A user can create, update and deleted his account -- A user can set language, timezone and first day of week. -- A user can reset his password (*new in 0.3.0*) -- A user can choose between metric system and imperial system for distance, elevation and speed display (*new in 0.5.0*) -- A user can set sport preferences (*new in 0.5.0*): - - change sport color (used for sport image and charts) - - can override stopped speed threshold (for next uploaded gpx files) - - disable/enable a sport. - -.. note:: - | If a sport is disabled by an administrator, it can not be enabled by a user. In this case, it will only appear in preferences if it has user's workouts and the user can only change sport color. - | A disabled sport (by admin or user) will not appear in dropdown when **adding a workout**. - | A workout with a disabled sport will still be displayed in the application. - - - Workouts ^^^^^^^^ - 11 sports are supported: @@ -100,37 +52,86 @@ Workouts .. note:: For now, only the owner of the workout can see it. + +Account & preferences +^^^^^^^^^^^^^^^^^^^^^ +- A user can create, update and deleted his account +- A user can set language, timezone and first day of week. +- A user can reset his password (*new in 0.3.0*) +- A user can choose between metric system and imperial system for distance, elevation and speed display (*new in 0.5.0*) +- A user can set sport preferences (*new in 0.5.0*): + - change sport color (used for sport image and charts) + - can override stopped speed threshold (for next uploaded gpx files) + - disable/enable a sport. + +.. note:: + | If a sport is disabled by an administrator, it can not be enabled by a user. In this case, it will only appear in preferences if the user has workouts and only sport color can be changed. + | A disabled sport (by admin or user) will not appear in dropdown when **adding a workout**. + | A workout with a disabled sport will still be displayed in the application. + + +Administration +^^^^^^^^^^^^^^ +(*new in 0.3.0*) + +- **Application** + + The following parameters can be set: + + - active users limit. If 0, registration is enabled (no limit defined) + - maximum size of uploaded files + - maximum size of zip archive + - maximum number of files in the zip archive. If an archive contains more files, only the configured number of files is processed, without raising errors. + + .. warning:: + Updating server configuration may be necessary to handle large files (like `nginx `_ for instance). + + +- **Users** + + - display users list and details + - edit a user to add/remove administration rights + - delete a user + +- **Sports** + + - enable or disable a sport (a sport can be disabled even if workout with this sport exists) + + Translations ^^^^^^^^^^^^ FitTrackee is available in English and French (which can be saved in the user preferences). +Screenshots +^^^^^^^^^^^^ + Dashboard -~~~~~~~~~ +""""""""" .. figure:: _images/fittrackee_screenshot-01.png :alt: FitTrackee Dashboard Workout detail -~~~~~~~~~~~~~~~~~~~~~~~ +"""""""""""""" .. figure:: _images/fittrackee_screenshot-02.png :alt: FitTrackee Workout Workouts list -~~~~~~~~~~~~~ +""""""""""""" .. figure:: _images/fittrackee_screenshot-03.png :alt: FitTrackee Workouts Statistics -~~~~~~~~~~ +"""""""""" .. figure:: _images/fittrackee_screenshot-04.png :alt: FitTrackee Statistics Administration -~~~~~~~~~~~~~~ +"""""""""""""" .. figure:: _images/fittrackee_screenshot-05.png :alt: FitTrackee Administration diff --git a/docs/_sources/installation.rst.txt b/docs/_sources/installation.rst.txt index 705f8564..74a5be38 100644 --- a/docs/_sources/installation.rst.txt +++ b/docs/_sources/installation.rst.txt @@ -230,17 +230,17 @@ To keep using **ThunderForest Outdoors**, the configuration is: .. note:: | Check the terms of service of tile provider for map attribution -From PyPI -~~~~~~~~~ - -.. note:: - | Recommended way on production. +Installation +~~~~~~~~~~~~ .. warning:: | Note that FitTrackee is under heavy development, some features may be unstable. -Installation -^^^^^^^^^^^^ +From PyPI +^^^^^^^^^ + +.. note:: + | Recommended way on production. - Create and activate a virtualenv @@ -298,41 +298,8 @@ For instance, copy and update ``.env`` file from ``.env.example`` and source the | To start application and workers with **systemd** service, see `Deployment `__ -Upgrade -^^^^^^^ - -.. warning:: - | Before upgrading, make a backup of all data: - | - database (with `pg_dump `__ for instance) - | - upload directory (see `Environment variables `__) - -- Activate the virtualenv - -- Upgrade with pip - -.. code-block:: bash - - $ pip install -U fittrackee - -- Update environment variables if needed and source environment variables file - -.. code-block:: bash - - $ nano .env - $ source .env - -- Upgrade database if needed - -.. code-block:: bash - - $ fittrackee_upgrade_db - - -- Restart the application and task queue workers. - - From sources -~~~~~~~~~~~~~ +^^^^^^^^^^^^ .. warning:: | Since FitTrackee 0.2.1, Python packages installation needs Poetry. @@ -349,10 +316,6 @@ From sources For other OS, see `Poetry Documentation `__ - -Installation -^^^^^^^^^^^^ - Dev environment """"""""""""""" @@ -396,13 +359,13 @@ Production environment .. warning:: | Note that FitTrackee is under heavy development, some features may be unstable. -- Download the last release (for now, it is the release v0.5.5): +- Download the last release (for now, it is the release v0.5.6): .. code:: bash - $ wget https://github.com/SamR1/FitTrackee/archive/v0.5.5.tar.gz - $ tar -xzf v0.5.5.tar.gz - $ mv FitTrackee-0.5.5 FitTrackee + $ wget https://github.com/SamR1/FitTrackee/archive/v0.5.6.tar.gz + $ tar -xzf v0.5.6.tar.gz + $ mv FitTrackee-0.5.6 FitTrackee $ cd FitTrackee - Create **.env** from example and update it @@ -431,8 +394,9 @@ Open http://localhost:5000, log in as admin (the email is ``admin@example.com`` and the password ``mpwoadmin``) and change the password + Upgrade -^^^^^^^ +~~~~~~~ .. warning:: | Before upgrading, make a backup of all data: @@ -440,6 +404,37 @@ Upgrade | - upload directory (see `Environment variables `__) +From PyPI +^^^^^^^^^ + +- Activate the virtualenv + +- Upgrade with pip + +.. code-block:: bash + + $ pip install -U fittrackee + +- Update environment variables if needed and source environment variables file + +.. code-block:: bash + + $ nano .env + $ source .env + +- Upgrade database if needed (see changelog for migrations): + +.. code-block:: bash + + $ fittrackee_upgrade_db + + +- Restart the application and task queue workers. + + +From sources +^^^^^^^^^^^^ + Dev environment """"""""""""""" @@ -451,11 +446,16 @@ Dev environment - Update **.env** if needed (see `Environment variables `__). -- Upgrade packages and database: +- Upgrade packages: .. code:: bash $ make install-dev + +- Upgrade database if needed (see changelog for migrations): + +.. code:: bash + $ make upgrade-db - Restart the server: @@ -477,22 +477,27 @@ Prod environment - Change to the directory where FitTrackee directory is located -- Download the last release (for now, it is the release v0.5.5) and overwrite existing files: +- Download the last release (for now, it is the release v0.5.6) and overwrite existing files: .. code:: bash - $ wget https://github.com/SamR1/FitTrackee/archive/v0.5.5.tar.gz - $ tar -xzf v0.5.5.tar.gz - $ cp -R FitTrackee-0.5.5/* FitTrackee/ + $ wget https://github.com/SamR1/FitTrackee/archive/v0.5.6.tar.gz + $ tar -xzf v0.5.6.tar.gz + $ cp -R FitTrackee-0.5.6/* FitTrackee/ $ cd FitTrackee - Update **.env** if needed (see `Environment variables `__). -- Upgrade packages and database: +- Upgrade packages: + +.. code:: bash + + $ make install-dev + +- Upgrade database if needed (see changelog for migrations): .. code:: bash - $ make install-python $ make upgrade-db - Restart the server and dramatiq workers: @@ -503,7 +508,7 @@ Prod environment Deployment -~~~~~~~~~~~~~ +~~~~~~~~~~ There are several ways to start **FitTrackee** web application and task queue library. @@ -591,7 +596,7 @@ Examples (to update depending on your application configuration and given distri .. code-block:: server { - listen 443 ssl; + listen 443 ssl http2; server_name example.com; ssl_certificate fullchain.pem; ssl_certificate_key privkey.pem; @@ -666,7 +671,7 @@ Development .. versionadded:: 0.5.0 -- an additional step is to install `fittrackee_client` +- an additional step is needed to install `fittrackee_client` .. code-block:: bash diff --git a/docs/_static/documentation_options.js b/docs/_static/documentation_options.js index d45bacf8..bc550202 100644 --- a/docs/_static/documentation_options.js +++ b/docs/_static/documentation_options.js @@ -1,6 +1,6 @@ var DOCUMENTATION_OPTIONS = { URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'), - VERSION: '0.5.5', + VERSION: '0.5.6', LANGUAGE: 'None', COLLAPSE_INDEX: false, BUILDER: 'html', diff --git a/docs/api/auth.html b/docs/api/auth.html index d4a67918..17ff90e6 100644 --- a/docs/api/auth.html +++ b/docs/api/auth.html @@ -5,7 +5,7 @@ - Authentication — FitTrackee 0.5.5 + <title>Authentication — FitTrackee 0.5.6 documentation @@ -22,10 +22,10 @@ - - - - + + + + @@ -40,7 +40,7 @@ FitTrackee - 0.5.5 + 0.5.6 diff --git a/docs/api/configuration.html b/docs/api/configuration.html index acc6c6df..20de675f 100644 --- a/docs/api/configuration.html +++ b/docs/api/configuration.html @@ -5,7 +5,7 @@ - Configuration — FitTrackee 0.5.5 + <title>Configuration — FitTrackee 0.5.6 documentation @@ -22,10 +22,10 @@ - - - - + + + + @@ -40,7 +40,7 @@ FitTrackee - 0.5.5 + 0.5.6 @@ -148,7 +148,7 @@ "max_zip_file_size": 10485760, "max_users": 0, "map_attribution": "&copy; <a href=http://www.openstreetmap.org/copyright>OpenStreetMap</a> contributors" - "version": "0.5.5" + "version": "0.5.6" }, "status": "success" } diff --git a/docs/api/index.html b/docs/api/index.html index 30a63fe4..fd71d0f6 100644 --- a/docs/api/index.html +++ b/docs/api/index.html @@ -5,7 +5,7 @@ - API documentation — FitTrackee 0.5.5 + <title>API documentation — FitTrackee 0.5.6 documentation @@ -22,10 +22,10 @@ - - - - + + + + @@ -40,7 +40,7 @@ FitTrackee - 0.5.5 + 0.5.6 diff --git a/docs/api/records.html b/docs/api/records.html index 777b9092..74a00d04 100644 --- a/docs/api/records.html +++ b/docs/api/records.html @@ -5,7 +5,7 @@ - Records — FitTrackee 0.5.5 + <title>Records — FitTrackee 0.5.6 documentation @@ -22,10 +22,10 @@ - - - - + + + + @@ -40,7 +40,7 @@ FitTrackee - 0.5.5 + 0.5.6 diff --git a/docs/api/sports.html b/docs/api/sports.html index 8407abc2..1a1882b7 100644 --- a/docs/api/sports.html +++ b/docs/api/sports.html @@ -5,7 +5,7 @@ - Sports — FitTrackee 0.5.5 + <title>Sports — FitTrackee 0.5.6 documentation @@ -22,10 +22,10 @@ - - - - + + + + @@ -40,7 +40,7 @@ FitTrackee - 0.5.5 + 0.5.6 diff --git a/docs/api/stats.html b/docs/api/stats.html index 81e6803d..67efd976 100644 --- a/docs/api/stats.html +++ b/docs/api/stats.html @@ -5,7 +5,7 @@ - Statistics — FitTrackee 0.5.5 + <title>Statistics — FitTrackee 0.5.6 documentation @@ -22,10 +22,10 @@ - - - - + + + + @@ -40,7 +40,7 @@ FitTrackee - 0.5.5 + 0.5.6 diff --git a/docs/api/users.html b/docs/api/users.html index f09522dc..d69f82b0 100644 --- a/docs/api/users.html +++ b/docs/api/users.html @@ -5,7 +5,7 @@ - Users — FitTrackee 0.5.5 + <title>Users — FitTrackee 0.5.6 documentation @@ -22,10 +22,10 @@ - - - - + + + + @@ -40,7 +40,7 @@ FitTrackee - 0.5.5 + 0.5.6 diff --git a/docs/api/workouts.html b/docs/api/workouts.html index e42a06f2..7d74684c 100644 --- a/docs/api/workouts.html +++ b/docs/api/workouts.html @@ -5,7 +5,7 @@ - Workouts — FitTrackee 0.5.5 + <title>Workouts — FitTrackee 0.5.6 documentation @@ -22,10 +22,10 @@ - - - - + + + + @@ -40,7 +40,7 @@ FitTrackee - 0.5.5 + 0.5.6 diff --git a/docs/changelog.html b/docs/changelog.html index dbfd6d88..e1ade063 100644 --- a/docs/changelog.html +++ b/docs/changelog.html @@ -5,7 +5,7 @@ - Change log — FitTrackee 0.5.5 + <title>Change log — FitTrackee 0.5.6 documentation @@ -21,10 +21,10 @@ - - - - + + + + @@ -39,7 +39,7 @@ FitTrackee - 0.5.5 + 0.5.6 @@ -77,184 +77,192 @@ role="menu" aria-labelledby="dLabelLocalToc">