diff --git a/README.md b/README.md index 6e39fe9..649081f 100644 --- a/README.md +++ b/README.md @@ -11,17 +11,21 @@ ColorCalc is a small Tkinter tool for analysing colour ranges in images. You loa ## Requirements - Python 3.11+ (3.10 works with `tomli`) +- [uv](https://github.com/astral-sh/uv) for dependency management - Tkinter (install separately on some Linux distros) -- Pillow (`pip install pillow`) -## Setup +## Setup with uv ```bash git clone https://github.com//ColorCalc.git cd ColorCalc -python3 -m venv .venv -source .venv/bin/activate # Windows: .venv\Scripts\activate -pip install pillow -python3 main.py +uv venv +source .venv/bin/activate # Windows: .venv\Scripts\activate +uv pip sync # installs Pillow + optional deps from pyproject +uv run colorcalc # launches the GUI +``` +To include the optional ttkbootstrap theme pack: +```bash +uv pip install '.[ui]' ``` ## Workflow @@ -53,5 +57,5 @@ main.py # entry point ``` ## Development -- Quick check: `python3 -m compileall app main.py` +- Quick check: `uv run python -m compileall app main.py` - Contributions welcome; include screenshots for UI tweaks. diff --git a/pyproject.toml b/pyproject.toml new file mode 100644 index 0000000..0053de0 --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,20 @@ +[project] +name = "colorcalc" +version = "0.1.0" +description = "Interactive colour range analyser for Tkinter" +readme = "README.md" +authors = [{ name = "ColorCalc contributors" }] +license = { text = "MIT" } +requires-python = ">=3.10" +dependencies = [ + "pillow>=10.0.0", +] + +[project.optional-dependencies] +ui = ["ttkbootstrap>=1.10.0"] + +[project.scripts] +colorcalc = "app.app:start_app" + +[tool.uv] +package = false