Skip to content

Commit

Permalink
add pre-commit as a git hook
Browse files Browse the repository at this point in the history
  • Loading branch information
DallanQ committed Oct 20, 2023
1 parent f8c1afc commit 1d7263d
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,12 +21,14 @@ Can be repurposed to create models and process data for any semantic search proj

Install rtx: https://github.com/jdx/rtx

- when you cd to the project directory, rtx should install the correct version of python, poetry, and pipx
- when you cd to the project directory, run `rtx install` to install the correct version of python, poetry, and pipx

Install dependencies using poetry: `poetry install`

Install nox: `poetry run pipx install nox && poetry run pipx inject nox nox-poetry`

Install pre-commit as a git hook: `poetry run pre-commit install`

Install spacy model: `poetry run python -m spacy download en_core_web_sm`

Create a `.env` file with the following variables:
Expand Down

0 comments on commit 1d7263d

Please sign in to comment.