Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
V
Vigenere-API
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Requirements
Code
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Locked files
Build
Pipelines
Jobs
Pipeline schedules
Test cases
Artifacts
Deploy
Releases
Package registry
Model registry
Operate
Terraform modules
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Issue analytics
Insights
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
GitLab community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
This is an archived project. Repository and other project resources are read-only.
Show more breadcrumbs
DAVID Axel
Vigenere-API
Commits
872155aa
Commit
872155aa
authored
May 3, 2023
by
DAVID Axel
Browse files
Options
Downloads
Patches
Plain Diff
docs:
Update INSTALL.md and README
parent
500c0396
No related branches found
No related tags found
No related merge requests found
Changes
2
Show whitespace changes
Inline
Side-by-side
Showing
2 changed files
INSTALL.md
+10
-21
10 additions, 21 deletions
INSTALL.md
README.md
+1
-1
1 addition, 1 deletion
README.md
with
11 additions
and
22 deletions
INSTALL.md
+
10
−
21
View file @
872155aa
...
@@ -64,7 +64,7 @@ pip install https://etulab.univ-amu.fr/d19006523/vigenere-api/-/packages/pypi/vi
...
@@ -64,7 +64,7 @@ pip install https://etulab.univ-amu.fr/d19006523/vigenere-api/-/packages/pypi/vi
## Run the API :
## Run the API :
```
shell
```
shell
python3
-m
vigenere
-
api
python3
-m
vigenere
_
api
```
```
# Development :
# Development :
...
@@ -154,40 +154,29 @@ poetry update
...
@@ -154,40 +154,29 @@ poetry update
## Run the API :
## Run the API :
```
shell
```
shell
p
oetry run start
p
ython
-m
vigenere_api
```
```
## Build the API package :
## Execute tests :
```
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:
```
shell
```
shell
git push
--tags
PYTHONPATH
=
.src pytest
```
```
##
# Major version
:
##
Execute coverage
:
```
shell
```
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
```
shell
poetry run bump-minor-vers
ion
PYTHONPATH
=
.src pytest
--with-integrat
ion
```
```
##
# Patch version
:
##
Build the API package
:
```
shell
```
shell
poetry
run bump-patch-version
poetry
build
```
```
This diff is collapsed.
Click to expand it.
README.md
+
1
−
1
View file @
872155aa
...
@@ -17,5 +17,5 @@ pip install https://etulab.univ-amu.fr/d19006523/vigenere-api/-/packages/pypi/vi
...
@@ -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 :
You can run the API with an HTTP server like :
```
shell
```
shell
python
-m
vigenere
-
api
python
-m
vigenere
_
api
```
```
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment