Skip to content

Commit e2b8e5c

Browse files
committed
docs: update repo docs to mention prek; as well as modernized Python
1 parent 0c7ea2f commit e2b8e5c

2 files changed

Lines changed: 12 additions & 19 deletions

File tree

CONTRIBUTING.md

Lines changed: 7 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -7,27 +7,19 @@ To get started with working on the codebase, use the following steps prepare you
77
git clone https://github.com/ApeWorX/ape-alchemy.git
88
cd ape-alchemy
99

10-
# create and load a virtual environment
11-
python3 -m venv venv
12-
source venv/bin/activate
13-
14-
# install ape-alchemy into the virtual environment
15-
python setup.py install
16-
17-
# install the developer dependencies (-e is interactive mode)
18-
pip install -e .'[dev]'
10+
# install the developer dependencies
11+
uv sync --group dev
1912
```
2013

21-
## Pre-Commit Hooks
14+
## Prek Hooks
2215

23-
We use [`pre-commit`](https://pre-commit.com/) hooks to simplify linting and ensure consistent formatting among contributors.
24-
Use of `pre-commit` is not a requirement, but is highly recommended.
16+
We use [`prek`](https://github.com/j178/prek) to run repository hooks and keep contributor workflows
17+
consistent. Use of `prek` is not a requirement, but is highly recommended.
2518

26-
Install `pre-commit` locally from the root folder:
19+
Install hooks locally from the root folder:
2720

2821
```bash
29-
pip install pre-commit
30-
pre-commit install
22+
uv run prek install
3123
```
3224

3325
Committing will now automatically run the local hooks and ensure that your commit passes all lint checks.

README.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ The `ape-alchemy` plugin supports the following ecosystems:
3939

4040
## Dependencies
4141

42-
- [python3](https://www.python.org/downloads) version 3.9 up to 3.12.
42+
- [Python 3](https://www.python.org/downloads) version 3.10 or greater.
4343

4444
## Installation
4545

@@ -51,14 +51,15 @@ You can install the latest release via [`pip`](https://pypi.org/project/pip/):
5151
pip install ape-alchemy
5252
```
5353

54-
### via `setuptools`
54+
### via source
5555

56-
You can clone the repository and use [`setuptools`](https://github.com/pypa/setuptools) for the most up-to-date version:
56+
You can clone the repository and install for development:
5757

5858
```bash
5959
git clone https://github.com/ApeWorX/ape-alchemy.git
6060
cd ape-alchemy
61-
python3 setup.py install
61+
uv sync --group dev
62+
uv run prek install
6263
```
6364

6465
## Quick Usage

0 commit comments

Comments
 (0)