Skip to content

Commit

Permalink
Document some commands for code quality
Browse files Browse the repository at this point in the history
  • Loading branch information
MasterKale committed Mar 28, 2024
1 parent fba4acc commit f018e9e
Showing 1 changed file with 29 additions and 0 deletions.
29 changes: 29 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,3 +85,32 @@ Python's unittest module can be used to execute everything in the **tests/** dir
```sh
venv $> python -m unittest
```

Auto-watching unittests can be achieved with a tool like nodemon.

**All tests:**
```sh
venv $> nodemon --exec "python -m unittest" --ext py
```

**An individual test file:**
```sh
venv $> nodemon --exec "python -m unittest tests/test_aaguid_to_string.py" --ext py
```

### Linting and Formatting

Linting is handled via `mypy`:

```sh
venv $> python -m mypy webauthn
Success: no issues found in 52 source files
```

The entire library is formatted using `black`:

```sh
venv $> python -m black webauthn --line-length=99
All done! ✨ 🍰 ✨
52 files left unchanged.
```

0 comments on commit f018e9e

Please sign in to comment.