mediathequeroubaix 0.2.0

Client for the library of Roubaix (Médiathèque Roubaix)

Python CLI for the library of Roubaix (Médiathèque Roubaix)

---

Source Code: https://github.com/tomsquest/mediathequeroubaix.py

PyPI: https://pypi.org/project/mediathequeroubaix/

---

Table of Contents

• Features
  • Loans
  • Usage
• Why I am doing this
• Changelog
• Installation
• Development
  • Testing
  • Pre-commit
  • Releasing
• Credits

Features

MédiathèqueRoubaix.py is a client for the libray of Roubaix, mediathequederoubaix.fr.

Loans

1. Display a list of your loans
2. ...for many card holders at once (family) (TODO)
3. Quickly get the next return date for all you cards (TODO)

Usage

Very basically for now, to list the loans of a single user defined in environment variable

$ export USERNAME="X001002003"
$ export PASSWORD="password00"

$ python src/mediathequeroubaix/main.py
Getting loans of user: X001002003

Number of loans: 2
- [ 1/02] Machine learning avec Scikit-learn, due on: 2022-12-04, NOT renewable
- [ 2/02] Programmation Python avancée, due on: 2022-12-04, renewable

Why I am doing this

I created this project to:

1. Learn Functional Programing
2. Learn typed and modern Python
3. Be able to quickly list and renew my loans

Changelog

See CHANGELOG.md

Installation

pip install mediathequeroubaix

Development

• Clone this repository
• Requirements:
  • Poetry
  • Python 3.10
• Create a virtual environment and install the dependencies

poetry install

• Activate the virtual environment

poetry shell

Testing

pytest

Pre-commit

pre-commit install

Or if you want to run all checks for all files:

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