lume-base
Base classes and architecture for LUME Python projects
Installation
Install using pip:
pip install lume-base
Development
We recommend using uv for development:
# Install uv
pip install uv
# Initialize uv project
uv init
# Install package in editable mode with dev dependencies
uv sync --extra dev
# Run tests
uv run pytest
or alternatively run pip commands directly in uv:
# Install package in editable mode with dev dependencies
uv pip install -e ".[dev]"
# Run tests
pytest
Linting and Formatting
This project uses pre-commit to manage code quality checks, including ruff for linting and formatting. Pre-commit hooks will automatically run on every commit.
# Install pre-commit (if not already installed from dev dependencies)
uv pip install pre-commit
# Install the git hook scripts
pre-commit install
# (Optional) Run against all files manually
pre-commit run --all-files
Once installed, pre-commit will automatically run checks whenever you commit changes. If any checks fail, the commit will be blocked until you fix the issues.
To manually run checks before committing:
# Run all pre-commit hooks
pre-commit run --all-files
# Or run only ruff checks
pre-commit run ruff --all-files
pre-commit run ruff-format --all-files
The CI pipeline will automatically run these checks on every push and pull request.
Building Documentation
# Install with docs dependencies
uv sync --extra docs
# Build docs
uv run mkdocs build
# Serve docs locally
uv run mkdocs serve
2 maintainers
Metadata
2 maintainers
Release files for lume-base 0.6.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| lume_base-0.6.0.tar.gz | 55.4 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| lume_base-0.6.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 109.2 kB
Release files / lume_base-0.6.0.tar.gz
| Download URL | lume_base-0.6.0.tar.gz |
|---|---|
| Size | 55.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
145fe8642f0b40c6aad835ab16949c569f69b79a35a0483262576dd15c96f8d2
|
|
BLAKE2b-256 checksum How to use checksums |
7fdc921a0001ad7f06d8b8b08b75e681664de70caa5e7129a0d4bad5bb4798b0
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
uv/0.12.13 {"installer":{"name":"uv","version":"0.12.13","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
Release files / lume_base-0.6.0-py3-none-any.whl
| Download URL | lume_base-0.6.0-py3-none-any.whl |
|---|---|
| Size | 53.8 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
3a75fc00b43205f82c7d2fd30aa418b983bad0910df0c065866bf9627971a791
|
|
BLAKE2b-256 checksum How to use checksums |
b9f08f8938e68b07cf764b2c305a642b9dc3c500700ca94c542d934969d12c2f
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
uv/0.12.13 {"installer":{"name":"uv","version":"0.12.13","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
