Skip to content
Snippets Groups Projects
Commit 872155aa authored by DAVID Axel's avatar DAVID Axel
Browse files

docs: :pencil: Update INSTALL.md and README

parent 500c0396
Branches
Tags
No related merge requests found
......@@ -64,7 +64,7 @@ pip install https://etulab.univ-amu.fr/d19006523/vigenere-api/-/packages/pypi/vi
## Run the API :
```shell
python3 -m vigenere-api
python3 -m vigenere_api
```
# Development :
......@@ -154,40 +154,29 @@ poetry update
## Run the API :
```shell
poetry run start
python -m vigenere_api
```
## Build the API package :
```shell
poetry build
```
## Bump version :
You can bump a new version of the package.<br>
The script increases the version of the package, and creates a new tag.<br>
You need to push tag, like:
## Execute tests :
```shell
git push --tags
PYTHONPATH=.src pytest
```
### Major version :
## Execute coverage :
```shell
poetry run bump-major-version
PYTHONPATH=.src pytest --cov=src --cov=tests --cov=src --cov=tests --junit-xml=coverage.xml --cov-report=html:coverage_html
```
### Minor version :
## Execute integration tests :
```shell
poetry run bump-minor-version
PYTHONPATH=.src pytest --with-integration
```
### Patch version :
## Build the API package :
```shell
poetry run bump-patch-version
poetry build
```
......@@ -17,5 +17,5 @@ pip install https://etulab.univ-amu.fr/d19006523/vigenere-api/-/packages/pypi/vi
You can run the API with an HTTP server like :
```shell
python -m vigenere-api
python -m vigenere_api
```
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment