Skip to content

Commit 2bfc30d

Browse files
authored
refactor: use prek; update docs (#71)
* refactor: use prek for pre commit * docs: update docs to use prek; update repo docs for modern py tools * chore: ignore uv.lock for library dev * fix: add GITHUB_TOKEN to avoid 403 * fix: with not env Fix indentation for the 'Install Foundry' step. * fix: try v1 instead of stable * fix: remove arguments from action Remove version specification for Foundry installation
1 parent a16158e commit 2bfc30d

3 files changed

Lines changed: 8 additions & 5 deletions

File tree

.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -126,3 +126,5 @@ version.py
126126
**/.DS_Store
127127
*.swp
128128
*.swo
129+
130+
uv.lock

README.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ A series of utilities for working with tokens, based on the [`py-tokenlists`](ht
44

55
## Dependencies
66

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

99
## Installation
1010

@@ -16,14 +16,15 @@ You can install the latest release via [`pip`](https://pypi.org/project/pip/):
1616
pip install ape-tokens
1717
```
1818

19-
### via `setuptools`
19+
### via source
2020

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

2323
```bash
2424
git clone https://github.com/ApeWorX/ape-tokens.git
2525
cd ape-tokens
26-
python3 setup.py install
26+
uv sync --group dev
27+
uv run prek install
2728
```
2829

2930
## Quick Usage

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ dev = [
6060
{ include-group = "lint" },
6161
{ include-group = "docs" },
6262
"commitlint",
63-
"pre-commit",
63+
"prek",
6464
"pytest-xdist",
6565
"pytest-watch",
6666
"IPython",

0 commit comments

Comments
 (0)