Skip to content
Merged
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
17 changes: 1 addition & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,14 +25,13 @@ Tools:
- [uv](https://docs.astral.sh/uv/): manage dependencies, Python versions and virtual environments
- [ruff](https://docs.astral.sh/ruff/): lint and format Python code
- [pytest](https://docs.pytest.org/en/): run unit tests
- [ty](https://github.com/astral-sh/ty): type check Python code
- [prek](https://github.com/j178/prek): manage pre-commit hooks (fast, Rust-based)
- [prettier](https://prettier.io/): format YAML and Markdown
- [codespell](https://github.com/codespell-project/codespell): check spelling in source code

## Installation

### Application

Install package and pinned dependencies with the [`uv`](https://docs.astral.sh/uv/) package manager:

1. Install `uv`. See instructions for Windows, Linux or MacOS [here](https://docs.astral.sh/uv/getting-started/installation/).
Expand All @@ -57,20 +56,6 @@ Install package and pinned dependencies with the [`uv`](https://docs.astral.sh/u
source .venv/bin/activate
```

### Library

If using `pip` or `uv pip`, a specific version of the package can be installed with:

```bash
pip install git+ssh://git@github.com/Komorebi-AI/python-template.git@0.1.0
```

It can also be added to the `requirements.in` or `pyproject.toml`. If using `uv`, it can be added as a dependency with:

```bash
uv add "template @ git+https://github.com/Komorebi-AI/python-template@0.1.0"
```

## Setup development environment (Unix)

Install [`uv`](https://docs.astral.sh/uv/getting-started/installation/) and prek hooks:
Expand Down
2 changes: 1 addition & 1 deletion uv.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading