mediathequeroubaix 1.0.1

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
  • Get the loans
• Usage
  • Install
  • Create an initial, sample configuration
  • Display the current configuration
  • List the loans
• Why I am doing this
• Changelog
• Installation
• Development
  • Releasing
• Credits

Features

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

Get the loans

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

Usage

Install

pip install mediathequederoubaix

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

⚠️ Only the first user in the config is supported. Multi-users is planned.

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 (especially when you have many cards)

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

• Pre-commit

pre-commit install

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

pre-commit run --all-files

• Testing

pytest

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