From c2a40dfc0ca7c5e433474fa9b7971c92989a0d94 Mon Sep 17 00:00:00 2001
From: why-not-try-calmer <mrnycticorax@gmail.com>
Date: Tue, 19 Dec 2023 16:28:41 +0100
Subject: [PATCH] docs

---
 docs/development.md | 14 +++++++++++
 requirements.in     |  8 +++++++
 requirements.txt    | 58 ++++++++++++++++++++++++++++++++-------------
 3 files changed, 64 insertions(+), 16 deletions(-)
 create mode 100644 requirements.in

diff --git a/docs/development.md b/docs/development.md
index 715a1dd6..d18daf76 100644
--- a/docs/development.md
+++ b/docs/development.md
@@ -1,4 +1,17 @@
 # Development
+
+## Upgrade dependencies
+
+Make sure you have `pip-tools` installed -- ideally in a virtual environment at the root of the project. Then run
+
+    pip-compile --upgrade
+
+In case something goes south, you can fall back on `requirements.in` to re-generate `requirements.txt`:
+
+    pip-compile requirements.in
+    # For good measure
+    pip-compile --upgrade
+
 ## Data model
 The data model has been created to easily allow to add functionality to the product
 e.g. adding new vehicle classes and to be as simple as possible and easily
@@ -44,3 +57,4 @@ The code of the plugin (directory =comptages=) is structured in the following wa
    | ui/                 | contains QT's files with the definition of the user interface dialogs              |
    | comptages.py        | plugin main module                                                                 |
    | metadata.txt        | plugin metadata                                                                    |
+
diff --git a/requirements.in b/requirements.in
new file mode 100644
index 00000000..26473902
--- /dev/null
+++ b/requirements.in
@@ -0,0 +1,8 @@
+django
+icalendar
+nose2
+numpy
+openpyxl
+pandas
+plotly
+psycopg2-binary
\ No newline at end of file
diff --git a/requirements.txt b/requirements.txt
index 9a0bc8e9..80b121d3 100644
--- a/requirements.txt
+++ b/requirements.txt
@@ -1,40 +1,66 @@
+#
+# This file is autogenerated by pip-compile with Python 3.10
+# by the following command:
+#
+#    pip-compile
+#
 asgiref==3.7.2
-    # via django
+    # via
+    #   comptages (pyproject.toml)
+    #   django
 django==5.0
-    # via -r requirements.in
+    # via comptages (pyproject.toml)
 et-xmlfile==1.1.0
-    # via openpyxl
+    # via
+    #   comptages (pyproject.toml)
+    #   openpyxl
 icalendar==5.0.11
-    # via -r requirements.in
+    # via comptages (pyproject.toml)
 nose2==0.14.0
-    # via -r requirements.in
+    # via comptages (pyproject.toml)
 numpy==1.26.2
-    # via pandas
+    # via
+    #   comptages (pyproject.toml)
+    #   pandas
 openpyxl==3.1.2
-    # via -r requirements.in
+    # via comptages (pyproject.toml)
 packaging==23.2
-    # via plotly
+    # via
+    #   comptages (pyproject.toml)
+    #   plotly
 pandas==2.1.4
-    # via -r requirements.in
+    # via comptages (pyproject.toml)
 plotly==5.18.0
-    # via -r requirements.in
+    # via comptages (pyproject.toml)
 psycopg2-binary==2.9.9
-    # via -r requirements.in
+    # via comptages (pyproject.toml)
 python-dateutil==2.8.2
     # via
+    #   comptages (pyproject.toml)
     #   icalendar
     #   pandas
 pytz==2023.3.post1
     # via
+    #   comptages (pyproject.toml)
     #   icalendar
     #   pandas
 six==1.16.0
-    # via python-dateutil
+    # via
+    #   comptages (pyproject.toml)
+    #   python-dateutil
 sqlparse==0.4.4
-    # via django
+    # via
+    #   comptages (pyproject.toml)
+    #   django
 tenacity==8.2.3
-    # via plotly
+    # via
+    #   comptages (pyproject.toml)
+    #   plotly
 typing-extensions==4.9.0
-    # via asgiref
+    # via
+    #   asgiref
+    #   comptages (pyproject.toml)
 tzdata==2023.3
-    # via pandas
+    # via
+    #   comptages (pyproject.toml)
+    #   pandas