Skip to content

Commit

Permalink
docs
Browse files Browse the repository at this point in the history
  • Loading branch information
why-not-try-calmer committed Dec 19, 2023
1 parent 0002479 commit 2518ec2
Show file tree
Hide file tree
Showing 3 changed files with 62 additions and 16 deletions.
12 changes: 12 additions & 0 deletions docs/development.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,15 @@
# Development

## Upgrade dependencies

1. Make you have `pip-tools` installed, ideally in a virtual environment at the root of the project.
2. Run `pip-compile --upgrade`

In case something goes south, you can fall back on `requirements.in` to re-generate `requirements.txt`:

1. `pip-compile requirements.in`
2. `pip-compile --upgrade` (for good measure)

## 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
Expand Down Expand Up @@ -44,3 +55,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 |

8 changes: 8 additions & 0 deletions requirements.in
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
django
icalendar
nose2
numpy
openpyxl
pandas
plotly
psycopg2-binary
58 changes: 42 additions & 16 deletions requirements.txt
Original file line number Diff line number Diff line change
@@ -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

0 comments on commit 2518ec2

Please sign in to comment.