Skip to content

Commit

Permalink
chore: remove requirements.txt
Browse files Browse the repository at this point in the history
Let's standardize on:

- pyproject.toml for halmos and its runtime dependencies (for users + devs)
- requirements-dev.txt for the dev dependencies (for devs only)
  • Loading branch information
karmacoma-eth committed Apr 18, 2024
1 parent abe353d commit 1e7b91c
Show file tree
Hide file tree
Showing 4 changed files with 9 additions and 7 deletions.
12 changes: 7 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,18 +23,20 @@ git clone [email protected]:a16z/halmos.git
Create and activate a virtual environment:

```sh
python3.11 -m venv .venv
source .venv/bin/activate
python3.12 -m venv .venv && source .venv/bin/activate
```

Install the dependencies:

```sh
python -m pip install -r requirements.txt
# install halmos and its runtime dependencies
python -m pip install -e .

# install the dev dependencies
python -m pip install -r requirements-dev.txt
```

Install and run the git hook scripts:
Install and run the git hook scripts (this is optional but will make sure that your PR will follow the style convention):

```sh
pre-commit install
Expand All @@ -46,7 +48,7 @@ pre-commit run --all-files
We recommend enabling the [black] formatter in your editor, but you can run it manually if needed:

```sh
python -m black .
python -m black src/
```

[black]: <https://black.readthedocs.io/en/stable/>
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[build-system]
requires = ["setuptools>=61.0", "setuptools_scm[toml]>=6.2", "black"]
requires = ["setuptools>=61.0", "setuptools_scm[toml]>=6.2"]
build-backend = "setuptools.build_meta"

[tool.setuptools_scm]
Expand Down
1 change: 1 addition & 0 deletions requirements-dev.txt
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
black
pre-commit
pytest
1 change: 0 additions & 1 deletion requirements.txt

This file was deleted.

0 comments on commit 1e7b91c

Please sign in to comment.