From ef708485a366375a0542858c5d81ed1a76f767b1 Mon Sep 17 00:00:00 2001 From: bronsen <kontakt+gitcommit@nrrd.de> Date: Mon, 17 Mar 2025 18:55:11 +0100 Subject: [PATCH] [readme] fiddle with texts, extend some sections, add a badge from ci.cbo --- README.md | 38 +++++++++++++++++++++++++++++--------- 1 file changed, 29 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 4037a7d..5af9907 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,9 @@ # Teilchensammler: Collect parts in a list +## Badges + +[](https://ci.c-base.org/repos/9) + ## Development This project makes use of [direnv] and [just]. @@ -8,13 +12,20 @@ This project makes use of [direnv] and [just]. recommend installing it and integrate it into your favourite shell. It works well with fish shell. -[just] ist used as a task runner. +[just] is used as a task runner. + +[woodpecker-cli] is used to lint `.woodpecker/workflow.yaml`. It is available +from [homebrew]. + +[pytest] is the test runner. Invoke it using `just test` (any arguments will be +passed through to pytest). ### Getting started -Have Python >= 3.12 installed. I use [pyenv] (which in turn is installed by [homebrew]). +Have Python >= 3.12 installed. I recommend [pyenv] (which in turn is easily +installed by [homebrew]). -Set up Postgresql, a role and a schema. I have it on localhost, using the +Set up PostgreSQL, a role and a schema. I have it on localhost, using the project name for role and schema name, and password. See `.env.test` for providing connection information. @@ -45,23 +56,32 @@ automatically generated from it by adding recursive tree of dependencies with fixed versions. The same goes for `test` and `dev`. To upgrade dependency versions, run `just deps` (or `pip-compile-multi --uv`). +And to install those packages run `just sync`. To run both of those: + +```shell +just deps sync +# OR +just fd +# OR +just freshdeps +``` To add a new dependency without upgrade, add it to the appropriate .in file and run `pip-compile-multi --no-upgrade` (no [just] recipe yet). ### Installing dependencies -For installation always use `.txt` files. +For installation of dependencies always use `requirement/*.txt` files. + +For example, the command `pip install -U -r requirements/dev.txt` will install +testing requirements and development tools. A useful command is `pip-sync requirements/dev.txt`, it uninstalls packages -from your virtualenv that aren't listed in the file. - -For example, command `pip install -Ue -. -r requirements/dev.txt` will install this project in development mode, -testing requirements and development tools. +from your virtualenv that aren't explicitly specified as dependencies. [pip-compile-multi]: https://pypi.org/project/pip-compile-multi/ [direnv]: https://direnv.net/ [just]: https://just.systems/ [pyenv]: https://github.com/pyenv/pyenv [homebrew]: https://brew.sh/ +[pytest]: https://pytest.org/