Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 12 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,14 +22,17 @@ Limitations:
## Installation

```
uv add mjpl
# or
pip install mjpl
```

## Development

For local development, clone the repository and install the developer dependencies:
This project uses [uv](https://docs.astral.sh/uv/) for dependency management and builds.
For local development, clone the repository and sync the developer dependencies:
```
pip install -e ".[dev]"
uv sync --extra dev
```

This project uses [Ruff](https://docs.astral.sh/ruff/) for linting and formatting.
Expand All @@ -38,28 +41,28 @@ Unit tests are written via the [unittest](https://docs.python.org/3/library/unit
To run the linter, formatter, and tests locally:
```bash
# Check for linter errors
ruff check .
uv run ruff check .
# Apply lint fixes
ruff check --fix .
uv run ruff check --fix .

# Check for format errors
ruff format --diff .
uv run ruff format --diff .
# Apply format fixes
ruff format .
uv run ruff format .

# Run unit tests
python3 -m unittest -v
uv run python -m unittest -v
```

[Pre-commit](https://pre-commit.com/) hooks are also available which run the linter, formatter, and unit tests.
To trigger the hooks automatically on commit, install the pre-commit hooks:
```
pre-commit install
uv run pre-commit install
```

To trigger the hooks manually:
```
pre-commit run --all-files
uv run pre-commit run --all-files
```

To bypass installed pre-commit hooks on commit:
Expand Down
8 changes: 4 additions & 4 deletions pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,7 +1,3 @@
[build-system]
requires = ["hatchling >= 1.27"]
build-backend = "hatchling.build"

[project]
name = "mjpl"
version = "0.0.1"
Expand Down Expand Up @@ -53,6 +49,10 @@ dev = [
[project.urls]
Homepage = "https://github.com/adlarkin/mjpl"

[build-system]
requires = ["uv_build>=0.9.4,<0.10.0"]
build-backend = "uv_build"

[tool.ruff]
target-version = "py310"

Expand Down