infuanfu/teilchensammler
2
0
Fork 0
Code Issues6 Pull requests Activity

[readme] fiddle with texts, extend some sections, add a badge from ci.cbo

Browse source
This commit is contained in:
bronsen 2025-03-17 18:55:11 +01:00
parent 848322f1d1
commit ef708485a3
1 changed files with 29 additions and 9 deletions

38
README.md
View file

@ -1,5 +1,9 @@
# Teilchensammler: Collect parts in a list # Teilchensammler: Collect parts in a list
## Badges
[![status-badge](https://ci.c-base.org/api/badges/9/status.svg)](https://ci.c-base.org/repos/9)
## Development ## Development
This project makes use of [direnv] and [just]. 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 recommend installing it and integrate it into your favourite shell. It works
well with fish shell. 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 ### 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 project name for role and schema name, and password. See `.env.test` for
providing connection information. 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`. fixed versions. The same goes for `test` and `dev`.
To upgrade dependency versions, run `just deps` (or `pip-compile-multi --uv`). 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 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). run `pip-compile-multi --no-upgrade` (no [just] recipe yet).
### Installing dependencies ### 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 A useful command is `pip-sync requirements/dev.txt`, it uninstalls packages
from your virtualenv that aren't listed in the file. from your virtualenv that aren't explicitly specified as dependencies.
For example, command `pip install -Ue
. -r requirements/dev.txt` will install this project in development mode,
testing requirements and development tools.
[pip-compile-multi]: https://pypi.org/project/pip-compile-multi/ [pip-compile-multi]: https://pypi.org/project/pip-compile-multi/
[direnv]: https://direnv.net/ [direnv]: https://direnv.net/
[just]: https://just.systems/ [just]: https://just.systems/
[pyenv]: https://github.com/pyenv/pyenv [pyenv]: https://github.com/pyenv/pyenv
[homebrew]: https://brew.sh/ [homebrew]: https://brew.sh/
[pytest]: https://pytest.org/