Skip to content

Commit

Permalink
Update README: install intructions
Browse files Browse the repository at this point in the history
  • Loading branch information
josecelano committed Dec 3, 2021
1 parent cd6d0f7 commit 4700876
Showing 1 changed file with 36 additions and 0 deletions.
36 changes: 36 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,42 @@

A Python Console application to handle media libraries like Git and [Dvc](https://github.com/iterative/dvc).

## Install

Requirements:

- Libvips
- Python 3.9

Install Python Package:

```shell
pip install nautilus-librarian
```

Example commands:

```shell
nautilus-librarian [OPTIONS] COMMAND [ARGS]...
nautilus-librarian --help
nautilus-librarian namecodes --help
nautilus-librarian namecodes validate-filename 000000-32.600.2.tif
```

You can also use the docker image from DockerHub registry:

```shell
docker run --rm -it ghcr.io/nautilus-cyberneering/librarian [OPTIONS] COMMAND [ARGS]...
docker run --rm -it ghcr.io/nautilus-cyberneering/librarian --help
```

Or the docker image from GitHub registry:

```shell
docker run --rm -it nautiluscyberneering/librarian [OPTIONS] COMMAND [ARGS]...
docker run --rm -it nautiluscyberneering/librarian --help
```

## Development

### Run
Expand Down

0 comments on commit 4700876

Please sign in to comment.