From 401a6586fd7f257dd877666ecc0fc182ab428a48 Mon Sep 17 00:00:00 2001 From: Thomas Queste Date: Sat, 2 Nov 2024 12:04:05 +0100 Subject: [PATCH] doc: review install instruction --- README.md | 51 ++++++++++++++++++++++----------------------------- 1 file changed, 22 insertions(+), 29 deletions(-) diff --git a/README.md b/README.md index 04ad327..6ae66d2 100644 --- a/README.md +++ b/README.md @@ -26,14 +26,13 @@ - [Display your loans](#display-your-loans) - [Renew your loans](#renew-your-loans) - [Usage](#usage) - - [Install](#install) + - [Running](#running) - [Create an initial, sample configuration](#create-an-initial-sample-configuration) - [Display the current configuration](#display-the-current-configuration) - [List the loans](#list-the-loans) - [Renew the loans](#renew-the-loans) - [Why I am doing this](#why-i-am-doing-this) - [Changelog](#changelog) -- [Installation](#installation) - [Development](#development) - [Releasing](#releasing) - [Credits](#credits) @@ -66,10 +65,24 @@ Running `mediathequeroubaix loans renew` will: ## Usage -### Install +### Running + +With Pipx: + +```shell +pipx run mediathequederoubaix +``` + +With UV: ```shell -pip install mediathequederoubaix +uvx mediathequederoubaix +``` + +If you want to install it globally: + +```shell +pipx install mediathequeroubaix ``` ### Create an initial, sample configuration @@ -133,37 +146,17 @@ I created this project to: See [CHANGELOG.md](CHANGELOG.md) -## Installation - -```sh -pip install mediathequeroubaix -``` - ## Development * Clone this repository -* Requirements: - * [Poetry](https://python-poetry.org/) - * Python 3.10 -* Create a virtual environment and install the dependencies - -```sh -poetry install +* Install [UV](https://docs.astral.sh/uv/) +* (Optional) if using direnv, create .envrc with: ``` - -* Activate the virtual environment - -```sh -poetry shell -``` - -* Install Pre-commit - -```sh -pre-commit install +uv sync +source .venv/bin/activate ``` -* Test +* Testing ```sh pytest