bump version to 0.8.0

SamR1 · Apr 21, 2024 · a42a040 · a42a040
1 parent 325f491
commit a42a040
Show file tree

Hide file tree

Showing 146 changed files with 9,895 additions and 4,481 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,54 @@
 # Change log
 
+## Version 0.8.0 (2024/04/21)
+
+**FitTrackee** now lets you associate [equipment](https://samr1.github.io/FitTrackee/en/features.html#equipments) with workouts and filter workouts on notes.
+
+### Features and enhancements
+
+* [#259](https://github.com/SamR1/FitTrackee/issues/259) - Feature request: "Equipment" that can be associated with workouts
+* [#512](https://github.com/SamR1/FitTrackee/issues/512) - Add ability to filter on notes in Workouts List
+
+### Bugs Fixed
+
+* [#508](https://github.com/SamR1/FitTrackee/issues/508) - Stopped speed threshold unit is missing on sports list
+* [3b6fa25](https://github.com/SamR1/FitTrackee/commit/3b6fa25e72375b5790a10761cdf7772ebfc02fbb) - fix workouts table display on small resolutions
+* [51758b4](https://github.com/SamR1/FitTrackee/commit/51758b45cd9e343b07409a55618879e4a8c534eb) - fix on filters hiding on small resolutions
+
+### Translations
+
+* [PR#507](https://github.com/SamR1/FitTrackee/pull/507) Translations update (Galician)
+* [PR#510](https://github.com/SamR1/FitTrackee/pull/510) Translations update (Spanish)
+* [PR#511](https://github.com/SamR1/FitTrackee/pull/511) Translations update (Galician)
+* [PR#521](https://github.com/SamR1/FitTrackee/pull/521) Translations update (Spanish)
+* [PR#524](https://github.com/SamR1/FitTrackee/pull/524) Translations update (Spanish)
+
+Translation status:
+- Basque: 89%
+- Dutch: 89%
+- English: 100%
+- French: 100%
+- Galician: 99%
+- German: 89%
+- Italian: 75%
+- Norwegian Bokmål: 53%
+- Polish: 89%
+- Spanish: 100%
+
+### Misc
+
+* [#502](https://github.com/SamR1/FitTrackee/issues/502) - Remove deprecated commands
+* [PR#506](https://github.com/SamR1/FitTrackee/pull/506) - CLI - update database commands
+
+
+Thanks to the contributors:
+- @jat255
+- @gallegonovato
+- @xmgz
+
+**Note:** This release contains database migration (see upgrade instructions in [documentation](https://samr1.github.io/FitTrackee/en/installation.html#upgrade))
+
+
 ## Version 0.7.32 (2024/03/10)
 
 ### Bugs Fixed

diff --git a/VERSION b/VERSION
@@ -1 +1 @@
-0.7.32
+0.8.0
diff --git a/docs/en/.buildinfo b/docs/en/.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: 42ef0a3fec4c3aeab00665164d44ebf7
+config: 10043307c9c6a1e66e043b352e705329
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/docs/en/_images/fittrackee_screenshot-01.png b/docs/en/_images/fittrackee_screenshot-01.png
diff --git a/docs/en/_images/fittrackee_screenshot-02.png b/docs/en/_images/fittrackee_screenshot-02.png
diff --git a/docs/en/_images/fittrackee_screenshot-03.png b/docs/en/_images/fittrackee_screenshot-03.png
diff --git a/docs/en/_images/fittrackee_screenshot-04.png b/docs/en/_images/fittrackee_screenshot-04.png
diff --git a/docs/en/_images/fittrackee_screenshot-05.png b/docs/en/_images/fittrackee_screenshot-05.png
diff --git a/docs/en/_images/fittrackee_screenshot-06.png b/docs/en/_images/fittrackee_screenshot-06.png
diff --git a/docs/en/_images/fittrackee_screenshot-07.png b/docs/en/_images/fittrackee_screenshot-07.png
diff --git a/docs/en/_images/fittrackee_screenshot-08.png b/docs/en/_images/fittrackee_screenshot-08.png
diff --git a/docs/en/_images/fittrackee_screenshot-09.png b/docs/en/_images/fittrackee_screenshot-09.png
diff --git a/docs/en/_images/fittrackee_screenshot-10.png b/docs/en/_images/fittrackee_screenshot-10.png
diff --git a/docs/en/_sources/api/equipment_types.rst.txt b/docs/en/_sources/api/equipment_types.rst.txt
@@ -0,0 +1,8 @@
+Equipment Types
+###############
+
+.. autoflask:: fittrackee:create_app()
+   :endpoints:
+    equipment_types.get_equipment_types,
+    equipment_types.get_equipment_type,
+    equipment_types.update_equipment_type
diff --git a/docs/en/_sources/api/equipments.rst.txt b/docs/en/_sources/api/equipments.rst.txt
@@ -0,0 +1,11 @@
+Equipments
+##########
+
+.. autoflask:: fittrackee:create_app()
+   :endpoints:
+    equipments.get_equipments,
+    equipments.get_equipment_by_id,
+    equipments.post_equipment,
+    equipments.update_equipment,
+    equipments.refresh_equipment,
+    equipments.delete_equipment
diff --git a/docs/en/_sources/api/index.rst.txt b/docs/en/_sources/api/index.rst.txt
@@ -7,6 +7,8 @@ API documentation
 
    auth
    configuration
+   equipments
+   equipment_types
    oauth2
    records
    sports

diff --git a/docs/en/_sources/changelog.md.txt b/docs/en/_sources/changelog.md.txt
@@ -1,5 +1,54 @@
 # Change log
 
+## Version 0.8.0 (2024/04/21)
+
+**FitTrackee** now lets you associate [equipment](https://samr1.github.io/FitTrackee/en/features.html#equipments) with workouts and filter workouts on notes.
+
+### Features and enhancements
+
+* [#259](https://github.com/SamR1/FitTrackee/issues/259) - Feature request: "Equipment" that can be associated with workouts
+* [#512](https://github.com/SamR1/FitTrackee/issues/512) - Add ability to filter on notes in Workouts List
+
+### Bugs Fixed
+
+* [#508](https://github.com/SamR1/FitTrackee/issues/508) - Stopped speed threshold unit is missing on sports list
+* [3b6fa25](https://github.com/SamR1/FitTrackee/commit/3b6fa25e72375b5790a10761cdf7772ebfc02fbb) - fix workouts table display on small resolutions
+* [51758b4](https://github.com/SamR1/FitTrackee/commit/51758b45cd9e343b07409a55618879e4a8c534eb) - fix on filters hiding on small resolutions
+
+### Translations
+
+* [PR#507](https://github.com/SamR1/FitTrackee/pull/507) Translations update (Galician)
+* [PR#510](https://github.com/SamR1/FitTrackee/pull/510) Translations update (Spanish)
+* [PR#511](https://github.com/SamR1/FitTrackee/pull/511) Translations update (Galician)
+* [PR#521](https://github.com/SamR1/FitTrackee/pull/521) Translations update (Spanish)
+* [PR#524](https://github.com/SamR1/FitTrackee/pull/524) Translations update (Spanish)
+
+Translation status:
+- Basque: 89%
+- Dutch: 89%
+- English: 100%
+- French: 100%
+- Galician: 99%
+- German: 89%
+- Italian: 75%
+- Norwegian Bokmål: 53%
+- Polish: 89%
+- Spanish: 100%
+
+### Misc
+
+* [#502](https://github.com/SamR1/FitTrackee/issues/502) - Remove deprecated commands
+* [PR#506](https://github.com/SamR1/FitTrackee/pull/506) - CLI - update database commands
+
+
+Thanks to the contributors:
+- @jat255
+- @gallegonovato
+- @xmgz
+
+**Note:** This release contains database migration (see upgrade instructions in [documentation](https://samr1.github.io/FitTrackee/en/installation.html#upgrade))
+
+
 ## Version 0.7.32 (2024/03/10)
 
 ### Bugs Fixed

diff --git a/docs/en/_sources/cli.rst.txt b/docs/en/_sources/cli.rst.txt
@@ -18,12 +18,6 @@ A command line interface (CLI) is available to manage database, OAuth2 tokens an
       oauth2  Manage OAuth2 tokens.
       users   Manage users.
 
-.. warning::
-    | The following commands are now deprecated and will be removed in a next version:
-    | - ``fittrackee_set_admin``
-    | - ``fittrackee_upgrade_db``
-    | - ``fittrackee_worker`` (disabled)
-
 
 Database
 ~~~~~~~~

diff --git a/docs/en/_sources/features.rst.txt b/docs/en/_sources/features.rst.txt
@@ -56,14 +56,15 @@ Workouts
   | Calculated values may differ from values calculated by the application that originally generated the gpx files, in particular the maximum speed.
 
 .. note::
-  | For now, **FitTrackee** does not have an importer, but some `third-party tools <third_party_tools.html#importers>`__ allow you to import workouts.
+  | For now, **FitTrackee** has no importer, but some `third-party tools <third_party_tools.html#importers>`__ allow you to import workouts.
 
 - | A workout can even be created without gpx (the user must enter date, time, duration and distance).
   | Ascent and descent can also be provided (*new in 0.7.10*).
 - | A workout with a gpx file can be displayed with map and charts (speed and elevation (if the gpx file contains elevation data, *updated in 0.7.20*)).
   | Controls allow full screen view and position reset (*new in 0.5.5*).
 - | If **Visual Crossing** (*new in 0.7.11*) API key is provided, weather is displayed in workout detail. Data source is displayed in **About** page.
   | Wind is displayed, with an arrow indicating the direction (a tooltip can be displayed with the direction that the wind is coming **from**) (*new in 0.5.5*).
+- An `equipment <features.html#equipments>`__ can be associated with a workout (*new in 0.8.0*). For now, only one equipment can be associated.
 - Segments can be displayed.
 - Workout gpx file can be downloaded (*new in 0.5.1*)
 - Workout edition and deletion. User can add a note.
@@ -88,7 +89,9 @@ Workouts
     - The user can filter workouts on:
         - date
         - sports (only sports with workouts are displayed in sport dropdown)
+        - equipment (only equipments with workouts are displayed in equipment dropdown) (*new in 0.8.0*)
         - title (*new in 0.7.15*)
+        - notes (*new in 0.8.0*)
         - distance
         - duration
         - average speed
@@ -114,10 +117,10 @@ Account & preferences
 .. note::
   In case email sending is not configured, a `command line <cli.html#ftcli-users-update>`__ allows to activate users account.
 
-- A user can set language, timezone and first day of week.
-- A user can set the interface theme (light, dark or according to browser preferences) (*new in 0.7.27*).
 - A user can reset his password (*new in 0.3.0*)
 - A user can change his email address (*new in 0.6.0*)
+- A user can set language, timezone and first day of week.
+- A user can set the interface theme (light, dark or according to browser preferences) (*new in 0.7.27*).
 - A user can choose between metric system and imperial system for distance, elevation and speed display (*new in 0.5.0*)
 - A user can choose to display or hide ascent records and total on Dashboard (*new in 0.6.11*)
 - A user can choose format used to display dates (*new in 0.7.3*)
@@ -130,20 +133,58 @@ Account & preferences
 - 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.
+     - disable/enable a sport
+     - define default `equipments <features.html#equipments>`__ (*new in 0.8.0*).
 
 .. 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.
 
-- A user can create `clients <apps.html>`__ for third-party applications (*new in 0.7.0*).
 - | A user can request a data export (*new in 0.7.13*).
   | It generates a zip archive containing 2 ``json`` files (user info and workouts data) and all uploaded gpx files.
 
 .. note::
   For now, it's not possible to import these files into another **FitTrackee** instance.
 
+OAuth Apps
+^^^^^^^^^^
+(*new in 0.7.0*)
+
+- A user can create `clients <apps.html>`__ for third-party applications.
+
+Equipments
+^^^^^^^^^^
+(*new in 0.8.0*)
+
+- A user can create equipments that can be associated with workouts.
+- The following equipment types are available, depending on the sport:
+    - Shoes: Hiking, Mountaineering, Running, Trail and Walking,
+    - Bike: Cycling (Sport, Transport, Trekking), Mountain Biking and Mountain Biking (Electric),
+    - Bike Trainer: Cycling (Virtual),
+    - Kayak/Boat: Rowing,
+    - Skis: Skiing (Alpine and Cross Country),
+    - Snowshoes: Snowshoes.
+- Equipment is visible only to its owner.
+- For now only, only one piece of equipment can be associated with a workout.
+- Following totals are displayed for each piece of equipment:
+    - total distance
+    - total duration
+    - total workouts
+
+.. note::
+  | In case of an incorrect total (although this should not happen), it is possible to recalculate totals.
+
+- It is possible to define default equipments for sports: when adding a workout, the equipment will automatically be displayed in the dropdown list depending on selected sport.
+- An equipment can be edited (label, equipment type, description, active status and default sports).
+
+.. warning::
+  | Changing equipment type will remove all existing workouts associations for that piece of equipment and default sports.
+
+- Deactivated equipment will not appear in dropdown when **a workout is added**. It remains displayed in the details of the workout, to which it was associated before being deactivated.
+
+.. note::
+  | An equipment type can be deactivated by an administrator.
 
 Administration
 ^^^^^^^^^^^^^^
@@ -199,6 +240,11 @@ Users
 - delete a user
 
 
+Equipment Types
+"""""""""""""""
+- enable or disable an equipment type in order to match disabled sports (a equipment type can be disabled even if equipment with this type exists)  (*new in 0.8.0*)
+
+
 Sports
 """"""
 - enable or disable a sport (a sport can be disabled even if workout with this sport exists)
@@ -251,6 +297,16 @@ Statistics
 .. figure:: _images/fittrackee_screenshot-04.png
    :alt: FitTrackee Statistics
 
+
+Equipments
+""""""""""
+.. figure:: _images/fittrackee_screenshot-09.png
+   :alt: FitTrackee Equipments
+
+.. figure:: _images/fittrackee_screenshot-10.png
+   :alt: FitTrackee Equipment detail
+
+
 Administration
 """"""""""""""
 .. figure:: _images/fittrackee_screenshot-05.png

diff --git a/docs/en/_sources/installation.rst.txt b/docs/en/_sources/installation.rst.txt
@@ -403,7 +403,7 @@ From PyPI
 .. note::
     | Simplest way to install FitTrackee.
 
-- Create and activate a virtualenv
+- Create and activate a `virtualenv <https://docs.python.org/3/library/venv.html>`__
 
 - Install **FitTrackee** with pip
 
@@ -529,13 +529,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.7.32):
+-  Download the last release (for now, it is the release v0.8.0):
 
 .. code:: bash
 
-   $ wget https://github.com/SamR1/FitTrackee/archive/v0.7.32.tar.gz
-   $ tar -xzf v0.7.32.tar.gz
-   $ mv FitTrackee-0.7.32 FitTrackee
+   $ wget https://github.com/SamR1/FitTrackee/archive/v0.8.0.tar.gz
+   $ tar -xzf v0.8.0.tar.gz
+   $ mv FitTrackee-0.8.0 FitTrackee
    $ cd FitTrackee
 
 -  Create **.env** from example and update it
@@ -593,7 +593,7 @@ From PyPI
 .. warning::
     | Only if **FitTrackee** was initially installed from **PyPI**
 
-- Stop the application and activate the virtualenv
+- Stop the application and activate the `virtualenv <https://docs.python.org/3/library/venv.html>`__
 
 - Upgrade with pip
 
@@ -666,13 +666,13 @@ Prod environment
 
 - Change to the directory where FitTrackee directory is located
 
-- Download the last release (for now, it is the release v0.7.32) and overwrite existing files:
+- Download the last release (for now, it is the release v0.8.0) and overwrite existing files:
 
 .. code:: bash
 
-   $ wget https://github.com/SamR1/FitTrackee/archive/v0.7.32.tar.gz
-   $ tar -xzf v0.7.32.tar.gz
-   $ cp -R FitTrackee-0.7.32/* FitTrackee/
+   $ wget https://github.com/SamR1/FitTrackee/archive/v0.8.0.tar.gz
+   $ tar -xzf v0.8.0.tar.gz
+   $ cp -R FitTrackee-0.8.0/* FitTrackee/
    $ cd FitTrackee
 
 - Update **.env** if needed (see `Environment variables <installation.html#environment-variables>`__).
@@ -924,4 +924,4 @@ Open http://localhost:3000
 Yunohost
 ~~~~~~~~
 
-A package is available, see https://github.com/YunoHost-Apps/fittrackee_ynh.
+Thanks to contributors, a package is available, see https://github.com/YunoHost-Apps/fittrackee_ynh.
diff --git a/docs/en/_sources/oauth.rst.txt b/docs/en/_sources/oauth.rst.txt
@@ -26,6 +26,8 @@ Scopes
 The following scopes are available:
 
 - ``application:write``: grants write access to application configuration (only for users with administration rights),
+- ``equipments:read``: grants read access to equipments endpoints (*new in 0.8.0*),
+- ``equipments:write``: grants write access to equipments endpoints (*new in 0.8.0*),
 - ``profile:read``: grants read access to auth endpoints,
 - ``profile:write``: grants write access to auth endpoints,
 - ``users:read``: grants read access to users endpoints,

diff --git a/docs/en/_sources/third_party_tools.rst.txt b/docs/en/_sources/third_party_tools.rst.txt
@@ -7,6 +7,7 @@ Import tools
 ~~~~~~~~~~~~
 - `strava-to-fittrackee <https://github.com/jat255/strava-to-fittrackee>`_ (import workouts from a Strava account)
 - `FitTrackee Uploader <https://github.com/ebrithiljonas/fittrackee-uploader>`_ (upload .gpx and .fit files)
+- `garmin-to-fittrackee <https://git.dryusdan.fr/Dryusdan/garmin-to-fittrackee>`_ (script to synchronize garmin to fittrackee)
 
 Installation scripts
 ~~~~~~~~~~~~~~~~~~~~

diff --git a/docs/en/_static/documentation_options.js b/docs/en/_static/documentation_options.js
@@ -1,6 +1,6 @@
 var DOCUMENTATION_OPTIONS = {
     URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
-    VERSION: '0.7.32',
+    VERSION: '0.8.0',
     LANGUAGE: 'en',
     COLLAPSE_INDEX: false,
     BUILDER: 'html',