Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

development section readme update #25

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 8 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,35 +32,26 @@ Add quickly a registration and authentication system to your [FastAPI](https://f

### Setup environment

You should create a virtual environment and activate it:
[Hatch](https://hatch.pypa.io/1.12/) is a project management tool used for environments and dependencies.

Install needed dependencies:
```bash
python -m venv venv/
hatch run pip install -e .
```

Get more information about [Hatch](https://hatch.pypa.io/1.12/):
```bash
source venv/bin/activate
```

And then install the development dependencies:

```bash
pip install -r requirements.dev.txt
hatch --help
```

### Run unit tests

You can run all the tests with:
To run all unit tests for the project execute:

```bash
make test
hatch run test
```

Alternatively, you can run `pytest` yourself:

```bash
pytest
```

There are quite a few unit tests, so you might run into ulimit issues where there are too many open file descriptors. You may be able to set a new, higher limit temporarily with:

Expand All @@ -73,7 +64,7 @@ ulimit -n 2048
Execute the following command to apply `isort` and `black` formatting:

```bash
make format
hatch run lint
```

## License
Expand Down