Skip to content

Installation

Prerequisites

RequirementVersionNotes
Python3.14+Enforced by the package
uvlatestPackage manager and tool runner

Install uv if you do not have it:

Terminal window
curl -LsSf https://astral.sh/uv/install.sh | sh

End-user install

Terminal window
uv tool install git+https://gitlab.com/oreohub/projects/copydeck

Verify the install:

Terminal window
copydeck --version

Developer install

Clone the repository and install dependencies:

Terminal window
git clone https://gitlab.com/oreohub/projects/copydeck
cd copydeck
uv sync
uv sync --dev

uv sync installs runtime dependencies only. uv sync --dev adds pre-commit, pytest, and ruff.

Using the task runner

The project ships a Taskfile.yml for common workflows:

Terminal window
task install # equivalent to: uv sync
task install:dev # equivalent to: uv sync --dev
task lint # ruff check
task fmt # ruff format
task test # pytest
task coverage # pytest with coverage report

Runtime dependencies

PackageRole
clickCLI framework
copierTemplate engine
inquirerInteractive prompts
pydantic + pydantic-settingsConfig models and env-var integration
python-gitlabGitLab API client
requestsHTTP
richTerminal table rendering

Next steps