bump to 0.8.13

SamR1 · Dec 29, 2024 · d4c827f · d4c827f
1 parent 279b305
commit d4c827f
Show file tree

Hide file tree

Showing 126 changed files with 6,411 additions and 5,404 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,38 @@
 # Change log
 
+## Version 0.8.13 (2024/12/29)
+
+### Translations
+
+* [PR#667](https://github.com/SamR1/FitTrackee/pull/667) - Translations update (Galicien)
+
+Translation status:
+- Basque: 100%
+- Bulgarian: 98%
+- Czech: 72%
+- Dutch: 99%
+- English: 100%
+- French: 100%
+- Galician: 100%
+- German: 100%
+- Italian: 81%
+- Norwegian Bokmål: 52%
+- Polish: 100%
+- Portuguese: 97%
+- Russian: 62%
+- Spanish: 100%
+
+### Misc
+
+* [#126](https://github.com/SamR1/FitTrackee/issues/126) - Docker's Container on docker hub
+* [PR#673](https://github.com/SamR1/FitTrackee/pull/673) - Publish package on PyPI using GitHub Actions workflow
+
+
+Thanks to the contributors:
+- @DavidHenryThoreau
+- @xmgz
+
+
 ## Version 0.8.12 (2024/11/17)
 
 ### Bugs Fixed
@@ -11,7 +44,6 @@
 * [PR#651](https://github.com/SamR1/FitTrackee/pull/651) - Tests - add databases to parallelize more tests
 
 
-
 ## Version 0.8.11 (2024/10/30)
 
 **FitTrackee** is now available for Python 3.13.

diff --git a/README.md b/README.md
@@ -1,18 +1,18 @@
 # FitTrackee
 **A simple self-hosted workout/activity tracker.**  
 
-[![PyPI version](https://img.shields.io/pypi/v/fittrackee.svg)](https://pypi.org/project/fittrackee/) 
+
 [![Python Version](https://img.shields.io/pypi/pyversions/fittrackee.svg)](https://python.org)
 [![Flask Version](https://img.shields.io/badge/flask-3.1-brightgreen.svg)](http://flask.pocoo.org/) 
 [![code formatter: ruff](https://img.shields.io/badge/code%20formatter-ruff-d7ff64)](https://docs.astral.sh/ruff/) 
 [![type check: mypy](https://img.shields.io/badge/type%20check-mypy-blue)](http://mypy-lang.org/)  
 [![Vue Version](https://img.shields.io/badge/vue-3.5-brightgreen.svg)](https://v3.vuejs.org/) 
 [![code formatter: prettier](https://img.shields.io/badge/code%20formatter-prettier-ff69b4.svg)](https://github.com/prettier/prettier) 
 [![Typescript Version](https://img.shields.io/npm/types/typescript)](https://www.typescriptlang.org/)  
+[![PyPI version](https://img.shields.io/pypi/v/fittrackee.svg)](https://pypi.org/project/fittrackee/)  [![docker: fittrackee/fittrackee](https://img.shields.io/badge/docker-fittrackee/fittrackee-2f7bee)](https://hub.docker.com/r/fittrackee/fittrackee)  
 [![pipeline status](https://github.com/SamR1/FitTrackee/actions/workflows/.tests-python.yml/badge.svg)](https://github.com/SamR1/FitTrackee/actions/workflows/.tests-python.yml)
 [![pipeline status](https://github.com/SamR1/FitTrackee/actions/workflows/.tests-javascript.yml/badge.svg)](https://github.com/SamR1/FitTrackee/actions/workflows/.tests-javascript.yml)
-[![translation status](https://hosted.weblate.org/widgets/fittrackee/-/svg-badge.svg)](https://hosted.weblate.org/engage/fittrackee/)  
-
+[![translation status](https://hosted.weblate.org/widgets/fittrackee/-/svg-badge.svg)](https://hosted.weblate.org/engage/fittrackee/)   
 ---
 
 Web application allowing tracking of outdoor activities (workouts) from GPX files, \

diff --git a/VERSION b/VERSION
@@ -1 +1 @@
-0.8.12
+0.8.13
diff --git a/docker-compose.yml b/docker-compose.yml
@@ -28,9 +28,10 @@ services:
     container_name: fittrackee
     env_file:
       - .env
-# TODO: to update on next release
-#    image: fittrackee/fittrackee:v0.8.13
-    build: .
+# Image from Docker Hub
+    image: fittrackee/fittrackee:v0.8.13
+# Uncomment following line to build image instead of using pre-built image
+#    build: .
     volumes:
       - ${UPLOAD_DIR:-./data/uploads}:/usr/src/app/uploads
       - ${UPLOAD_LOG:-./data/logs}:/usr/src/app/logs
@@ -61,9 +62,10 @@ services:
 #    container_name: fittrackee-workers
 #    env_file:
 #      - .env
-## TODO: to update on next release
-##    image: fittrackee/fittrackee:v0.8.13
-#    build: .
+## Image from Docker Hub
+#    image: fittrackee/fittrackee:v0.8.13
+## Uncomment following line to build image instead of using pre-built image
+##    build: .
 #    volumes:
 #      - ${UPLOAD_LOG:-./data/logs}:/usr/src/app/logs
 #    post_start:

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: 3569b0304590d86389f79e54c10d6b9a
+config: 306a9e16d377977980ae964bbcf57f98
 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/_images/fittrackee_screenshot-11.png b/docs/en/_images/fittrackee_screenshot-11.png
diff --git a/docs/en/_sources/changelog.md.txt b/docs/en/_sources/changelog.md.txt
@@ -1,5 +1,38 @@
 # Change log
 
+## Version 0.8.13 (2024/12/29)
+
+### Translations
+
+* [PR#667](https://github.com/SamR1/FitTrackee/pull/667) - Translations update (Galicien)
+
+Translation status:
+- Basque: 100%
+- Bulgarian: 98%
+- Czech: 72%
+- Dutch: 99%
+- English: 100%
+- French: 100%
+- Galician: 100%
+- German: 100%
+- Italian: 81%
+- Norwegian Bokmål: 52%
+- Polish: 100%
+- Portuguese: 97%
+- Russian: 62%
+- Spanish: 100%
+
+### Misc
+
+* [#126](https://github.com/SamR1/FitTrackee/issues/126) - Docker's Container on docker hub
+* [PR#673](https://github.com/SamR1/FitTrackee/pull/673) - Publish package on PyPI using GitHub Actions workflow
+
+
+Thanks to the contributors:
+- @DavidHenryThoreau
+- @xmgz
+
+
 ## Version 0.8.12 (2024/11/17)
 
 ### Bugs Fixed
@@ -11,7 +44,6 @@
 * [PR#651](https://github.com/SamR1/FitTrackee/pull/651) - Tests - add databases to parallelize more tests
 
 
-
 ## Version 0.8.11 (2024/10/30)
 
 **FitTrackee** is now available for Python 3.13.

diff --git a/docs/en/_sources/installation.rst.txt b/docs/en/_sources/installation.rst.txt
@@ -39,15 +39,23 @@ Prerequisites
 ~~~~~~~~~~~~~
 
 - mandatory
-    - Python 3.9+
-    - PostgreSQL 12+
+
+  - installation from sources or package:
+
+    - `Python <https://www.python.org/>`__ 3.9+
+    - `PostgreSQL <https://www.postgresql.org/>`__ 12+
+
+  - installation with Docker:
+
+    - `Docker <https://docs.docker.com/get-started/>`__ and `Docker Compose <https://docs.docker.com/compose/>`__ v2.30+
+
 - optional
-    - Redis for task queue (if email sending is enabled and for data export requests) and API rate limits
-    - SMTP provider (if email sending is enabled)
-    - API key from a `weather data provider <installation.html#weather-data>`__
-    - `Poetry <https://python-poetry.org>`__ 1.2+ (for installation from sources only)
-    - `Node <https://nodejs.org>`__ 18+ and `Yarn <https://yarnpkg.com>`__ (for development only)
-    -  Docker and Docker Compose (for development or evaluation purposes)
+
+  - `Redis <https://redis.io/>`__ for task queue (if email sending is enabled and for data export requests) and API rate limits (for installation from sources or package)
+  - SMTP provider (if email sending is enabled)
+  - API key from a `weather data provider <installation.html#weather-data>`__
+  - `Poetry <https://python-poetry.org>`__ 1.2+ (for installation from sources only)
+  - `Node <https://nodejs.org>`__ 18+ and `Yarn <https://yarnpkg.com>`__ (for development only)
 
 .. note::
     | If registration is enabled, it is recommended to set Redis and a SMTP provider for email sending and data export requests.
@@ -260,6 +268,53 @@ deployment method.
 
     .. versionchanged:: 0.7.26 ⚠️ replaces ``VUE_APP_API_URL``
 
+    **FitTrackee** API URL, only needed in dev environment.
+
+Docker
+^^^^^^
+
+.. versionadded:: 0.8.13
+
+Environment variables for ``docker-compose.yml``
+
+.. envvar:: APP_PORT
+
+    Application container port
+
+
+.. envvar:: DATABASE_DIR
+
+    Host directory for PostgreSQL data volume
+
+
+.. envvar:: POSTGRES_USER
+
+    User for PostgreSQL database
+
+
+.. envvar:: POSTGRES_PASSWORD
+
+    Password for PostgreSQL user
+
+
+.. envvar:: POSTGRES_DB
+
+    Database name for FitTrackee application
+
+
+.. envvar:: REDIS_DIR
+
+    Host directory for redis data volume
+
+
+.. envvar:: LOG_DIR
+
+    Host directory for logs volume
+
+
+.. envvar:: UPLOAD_DIR
+
+    Host directory for uploaded files volume
 
 
 Emails
@@ -529,13 +584,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.8.12):
+-  Download the last release (for now, it is the release v0.8.13):
 
 .. code:: bash
 
-   $ wget https://github.com/SamR1/FitTrackee/archive/v0.8.12.tar.gz
-   $ tar -xzf v0.8.12.tar.gz
-   $ mv FitTrackee-0.8.12 FitTrackee
+   $ wget https://github.com/SamR1/FitTrackee/archive/v0.8.13.tar.gz
+   $ tar -xzf v0.8.13.tar.gz
+   $ mv FitTrackee-0.8.13 FitTrackee
    $ cd FitTrackee
 
 -  Create **.env** from example and update it
@@ -666,13 +721,13 @@ Prod environment
 
 - Change to the directory where FitTrackee directory is located
 
-- Download the last release (for now, it is the release v0.8.12) and overwrite existing files:
+- Download the last release (for now, it is the release v0.8.13) and overwrite existing files:
 
 .. code:: bash
 
-   $ wget https://github.com/SamR1/FitTrackee/archive/v0.8.12.tar.gz
-   $ tar -xzf v0.8.12.tar.gz
-   $ cp -R FitTrackee-0.8.12/* FitTrackee/
+   $ wget https://github.com/SamR1/FitTrackee/archive/v0.8.13.tar.gz
+   $ tar -xzf v0.8.13.tar.gz
+   $ cp -R FitTrackee-0.8.13/* FitTrackee/
    $ cd FitTrackee
 
 - Update **.env** if needed (see `Environment variables <installation.html#environment-variables>`__).
@@ -834,23 +889,57 @@ Examples:
 Docker
 ~~~~~~
 
-Installation
-^^^^^^^^^^^^
-
 .. versionadded:: 0.4.4
+.. versionchanged:: 0.5.0 add client application for development
+.. versionchanged:: 0.8.13 add docker image for production
+
+
+Production
+^^^^^^^^^^
+
+Images are available on `DockerHub <https://hub.docker.com/r/fittrackee/fittrackee>`_ or `Github registry <https://github.com/SamR1/FitTrackee/packages>`_.
+
+.. note::
+
+    Images are available for ``linux/amd64`` and ``linux/arm64`` platforms. Only ``linux/amd64`` image has been tested.
+
+- create a ``docker-compose.yml`` file as needed (see the example in the repository):
+
+  - the minimal set up requires at least the database and the web application
+  - to activate the rate limit, redis is required
+  - to send e-mails, redis and workers are required and a valid ``EMAIL_URL`` variable must be set in ``.env``
+
+.. note::
+    The same image is used by the web application and workers.
+
+- create ``.env`` from example (``.env.docker.example``) and update it (see `Environment variables <installation.html#environment-variables>`__).
+
+- to start the application:
 
-For **evaluation** purposes, docker files are available, installing **FitTrackee** from **sources**.
+.. code:: bash
+
+   $ docker compose up -d
 
 .. warning::
-    Docker files are not suitable for production installation.
+
+    Migrations are executed at startup. Please backup data before updating FitTrackee image version.
+
+- to run a CLI command, for instance to give admin rights:
+
+.. code:: bash
+
+   $ docker compose exec fittrackee ftcli users update <username> --set-admin true
+
+
+Development
+^^^^^^^^^^^
 
 - To install and run **FitTrackee**:
 
 .. code-block:: bash
 
     $ git clone https://github.com/SamR1/FitTrackee.git
     $ cd FitTrackee
-    $ cp .env.docker .env
     $ make docker-run
 
 - Open http://localhost:5000 and register.
@@ -878,12 +967,6 @@ Open http://localhost:8025 to access `MailHog interface <https://github.com/mail
 
     $ make docker-shell
 
-
-Development
-^^^^^^^^^^^
-
-.. versionadded:: 0.5.0
-
 - an additional step is needed to install ``fittrackee_client``
 
 .. code-block:: bash

diff --git a/docs/en/_static/documentation_options.js b/docs/en/_static/documentation_options.js
@@ -1,5 +1,5 @@
 const DOCUMENTATION_OPTIONS = {
-    VERSION: '0.8.12',
+    VERSION: '0.8.13',
     LANGUAGE: 'en',
     COLLAPSE_INDEX: false,
     BUILDER: 'html',

diff --git a/docs/en/api/auth.html b/docs/en/api/auth.html
@@ -6,7 +6,7 @@
 <link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="Configuration" href="configuration.html" /><link rel="prev" title="API documentation" href="index.html" />
 
     <!-- Generated with Sphinx 7.4.7 and Furo 2024.08.06 -->
-        <title>Authentication and account - FitTrackee 0.8.12 documentation</title>
+        <title>Authentication and account - FitTrackee 0.8.13 documentation</title>
       <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=fa44fd50" />
     <link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?v=354aac6f" />
     <link rel="stylesheet" type="text/css" href="../_static/copybutton.css?v=76b2166b" />
@@ -169,7 +169,7 @@
       </label>
     </div>
     <div class="header-center">
-      <a href="../index.html"><div class="brand">FitTrackee 0.8.12
+      <a href="../index.html"><div class="brand">FitTrackee 0.8.13
  documentation</div></a>
     </div>
     <div class="header-right">
@@ -197,7 +197,7 @@
     <img class="sidebar-logo" src="../_static/ft-logo.png" alt="Logo"/>
   </div>
 
-  <span class="sidebar-brand-text">FitTrackee 0.8.12
+  <span class="sidebar-brand-text">FitTrackee 0.8.13
  documentation</span>
 
 </a><form class="sidebar-search-container" method="get" action="../search.html" role="search">
@@ -1655,7 +1655,7 @@ <h1>Authentication and account<a class="headerlink" href="#authentication-and-ac
 
     </aside>
   </div>
-</div><script src="../_static/documentation_options.js?v=ad8d0c89"></script>
+</div><script src="../_static/documentation_options.js?v=09f58890"></script>
     <script src="../_static/doctools.js?v=9a2dae69"></script>
     <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../_static/scripts/furo.js?v=5fa4622c"></script>