-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
42 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,41 @@ | ||
# Usage guide | ||
|
||
## Installation | ||
|
||
Make sure that you have [Poetry](https://python-poetry.org/) installed. After cloning the repository to your computer move to its root directory and run | ||
|
||
``` | ||
poetry install | ||
``` | ||
|
||
## Usage | ||
|
||
Currently `kyber` provides three main functions that can be used directly from Python code. A sample usage is included in `main.py`. | ||
|
||
At the moment there is no GUI or CLI available. | ||
|
||
### Tests | ||
|
||
Unit tests can be run with | ||
|
||
``` | ||
poetry run invoke test | ||
``` | ||
|
||
### Coverage | ||
|
||
Coverage report can be created with | ||
|
||
``` | ||
poetry run invoke coverage-report | ||
``` | ||
|
||
after which the report will appear at `htmlcov/index.html`. | ||
|
||
### Lint | ||
|
||
Run static style cheking with | ||
|
||
``` | ||
poetry run invoke lint | ||
``` |