nautilus-librarian 0.1.0

A Python Console application to handle media libraries like Git and DVC

Nautilus Librarian

A Python Console application to handle media libraries like Git and Dvc.

Development

Run

With docker:

Build:

./bin/docker/build.sh

Run pre-built docker image:

./bin/docker/run.sh [OPTIONS] COMMAND [ARGS]...
./bin/docker/run.sh --help

Run mounting current repo:

./bin/docker/run-dev.sh [OPTIONS] COMMAND [ARGS]...
./bin/docker/run-dev.sh --help

With Poetry:

poetry install
poetry run nautilus-librarian [OPTIONS] COMMAND [ARGS]...
poetry run nautilus-librarian --help

NOTE: With Poetry, you have to install the Librarian system dependencies.

Testing

With docker:

./bin/docker/test.sh

With Poetry:

poetry shell
pytest

or:

poetry run pytest --cov

Linting

For Dockerfile:

We are using GitHub Action super-linter. If you want to check the Dockerfile linting before pushing, you can do it with:

docker run --rm -i hadolint/hadolint < Dockerfile

Run super-linter locally with act:

act -W .github/workflows/linter.yml -j build