-
Notifications
You must be signed in to change notification settings - Fork 14
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* feat: added README.md * feat: added W503 line break before binary operator ignore
- Loading branch information
1 parent
923cf3c
commit 102d3ee
Showing
1 changed file
with
33 additions
and
0 deletions.
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,33 @@ | ||
# Voltaserve Console API | ||
|
||
## Getting Started | ||
|
||
Install dependencies: | ||
|
||
```shell | ||
poetry install --no-interaction --no-cache | ||
``` | ||
|
||
Activate the virtual environment created by Poetry: | ||
|
||
```shell | ||
source /home/your_user/.cache/pypoetry/virtualenvs/voltaserve-console-something/bin/activate | ||
``` | ||
|
||
Run: | ||
|
||
```shell | ||
poetry run python -m api.uvi | ||
``` | ||
|
||
Lint code: | ||
|
||
```shell | ||
flake8 . --extend-ignore F401,W291,W503 --max-line-length 120 --extend-exclude Dockerfile | ||
``` | ||
|
||
Format code: | ||
|
||
```shell | ||
black . | ||
``` |