Skip to content

Commit

Permalink
docs: migrate to uv
Browse files Browse the repository at this point in the history
Replace references to Poetry with uv.
  • Loading branch information
jonbiemond committed Aug 21, 2024
1 parent db397cd commit 827fec7
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 8 deletions.
12 changes: 6 additions & 6 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,20 +6,20 @@ To make a contribution, follow these steps:
2. Make changes in a new branch including the issue number. e.g. `git checkout -b 42-new-feature`.
3. If you modified the code (new feature or bug-fix), please add tests for it.
4. Check the linting. [see below](https://github.com/jonbiemond/heave/blob/main/CONTRIBUTING.md#-linting)
6. Ensure that all tests pass. [see below](https://github.com/jonbiemond/heave/blob/main/CONTRIBUTING.md#-testing)
7. Submit a pull request.
5. Ensure that all tests pass. [see below](https://github.com/jonbiemond/heave/blob/main/CONTRIBUTING.md#-testing)
6. Submit a pull request.

For more details about pull requests, please read [GitHub's guides](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request).


### 📦 Package manager

We use `poetry` as our package manager. You can install poetry by following the instructions [here](https://python-poetry.org/docs/#installation).
We use `uv` as our package manager. You can install uv by following the instructions [here](https://docs.astral.sh/uv/getting-started/installation/).

Please DO NOT use pip or conda to install the dependencies. Instead, use poetry:
Please DO NOT use pip or conda to install the dependencies. Instead, use uv:

```bash
poetry install
uv venv
```

### 📌 Pre-commit
Expand All @@ -35,7 +35,7 @@ pre-commit install
Use `ruff` to lint your code. You can run the linter by running the following command:

```bash
ruff .
ruff check .
```

Make sure that the linter does not report any errors or warnings before submitting a pull request.
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@ Heave is a CLI tool for batch inserting or updating data into a database.

## Installation

It is recommended to install `heave` using [pipx](https://github.com/pypa/pipx):
It is recommended to install `heave` using [uv](https://docs.astral.sh/uv/guides/tools/#installing-tools):
```bash
pipx install heave
uv tool install heave
```

## Usage
Expand Down

0 comments on commit 827fec7

Please sign in to comment.