Skip to content

Commit

Permalink
doc: review install instruction
Browse files Browse the repository at this point in the history
  • Loading branch information
tomsquest committed Nov 2, 2024
1 parent cd1d24e commit 401a658
Showing 1 changed file with 22 additions and 29 deletions.
51 changes: 22 additions & 29 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down

0 comments on commit 401a658

Please sign in to comment.