Client for the library of Roubaix (Médiathèque Roubaix)
Project description
Python CLI for the library of Roubaix (Médiathèque Roubaix)
Releases: https://github.com/tomsquest/mediathequeroubaix.py/releases
Source Code: https://github.com/tomsquest/mediathequeroubaix.py
PyPI: https://pypi.org/project/mediathequeroubaix/
Table of Contents
Features
MédiathèqueRoubaix.py is a client for the libray of Roubaix, mediathequederoubaix.fr.
Display your loans
Running mediathequeroubaix loans list
will:
- Get the list of your loans and their due date
- ...for many cardholders
- and check the next return date for each of your card
Renew your loans
Running mediathequeroubaix loans renew
will:
- Renew automatically all loans
- ...for many cardholders
- and print the new due date of the loans
Usage
Running
With Pipx:
pipx run mediathequederoubaix
With UV:
uvx mediathequederoubaix
If you want to install it globally:
pipx install mediathequeroubaix
Create an initial, sample configuration
config create
makes a sample configuration in $HOME/.config/mediathequederoubaix/config.json
and display the content of the file.
The configuration is initialized with a sample but fake user.
mediathequeroubaix config create
Display the current configuration
config show
displays the current configuration.
mediathequeroubaix config show
List the loans
loans list
show the list of loans for the users.
mediathequeroubaix loans list
Renew the loans
loans renew
renew the list of loans for the users and display the new loans.
mediathequeroubaix loans renew
Why I am doing this
I created this project to:
- Learn Functional Programing
- Learn typed and modern Python
- Be able to quickly list and renew my loans (especially when you have many cards)
Changelog
See CHANGELOG.md
Development
- Clone this repository
- Install UV
- (Optional) if using direnv, create .envrc with:
uv sync
source .venv/bin/activate
- Testing
pytest
- Check everything in one go
pre-commit run --all-files
Releasing
Trigger the Draft release workflow (press Run workflow). This will update the changelog & version and create a GitHub release which is in Draft state.
Find the draft release from the GitHub releases and publish it. When a release is published, it'll trigger release workflow which creates PyPI release.
Credits
- Background and color from PrettySnap
- Python project bootstrapped using Wolt template
- Functional library is Returns from DRY-Python
- Tables look great thanks to Textualize's Rich
- CLI screenshot pimped with ShowCode.app