Skip to content
Snippets Groups Projects
Commit 02b41f86 authored by Moul's avatar Moul
Browse files

[doc] contributing: fix typo: PyPi −> PyPI

parent 5cdf641f
No related branches found
No related tags found
1 merge request!146Merge dev into master branch to complete v0.8.0 development cycle
Pipeline #7277 passed
...@@ -82,20 +82,20 @@ To create a release, we use following script which will update the version in di ...@@ -82,20 +82,20 @@ To create a release, we use following script which will update the version in di
Then, a `git push --tags` is necessary to publish the tag. Git could be configured to publish tags with a simple `push`. Then, a `git push --tags` is necessary to publish the tag. Git could be configured to publish tags with a simple `push`.
## PyPi and PyPi test distributions ## PyPI and PyPI test distributions
Silkaj is distributed to PyPi, the Python Package Index, for further `pip` installation. Silkaj is distributed to PyPI, the Python Package Index, for further `pip` installation.
Silkaj can be published to [PyPi](https://pypi.org/project/silkaj) or to [PyPi test](https://test.pypi.org/project/silkaj/) for testing purposes. Silkaj can be published to [PyPI](https://pypi.org/project/silkaj) or to [PyPI test](https://test.pypi.org/project/silkaj/) for testing purposes.
Publishing to PyPi or PyPi test can be directly done from the continuous delivery or from Poetry it-self. Publishing to PyPI or PyPI test can be directly done from the continuous delivery or from Poetry it-self.
The CD jobs does appear on a tag and have to be triggered manually. The CD jobs does appear on a tag and have to be triggered manually.
Only the project maintainers have the rights to publish tags. Only the project maintainers have the rights to publish tags.
### PyPi ### PyPI
Publishing to PyPi from Poetry: Publishing to PyPI from Poetry:
```bash ```bash
poetry publish --build poetry publish --build
``` ```
### PyPi test ### PyPI test
Publishing to PyPi test from Poetry: Publishing to PyPI test from Poetry:
```bash ```bash
poetry config repositories.pypi_test https://test.pypi.org/legacy/ poetry config repositories.pypi_test https://test.pypi.org/legacy/
poetry publish --build --repository pypi_test poetry publish --build --repository pypi_test
...@@ -106,7 +106,7 @@ To install this package: ...@@ -106,7 +106,7 @@ To install this package:
pip install --index-url https://test.pypi.org/simple/ --extra-index-url https://pypi.python.org/simple/ silkaj pip install --index-url https://test.pypi.org/simple/ --extra-index-url https://pypi.python.org/simple/ silkaj
``` ```
The `--extra-index-url` is used to retrieve dependencies packages from the official PyPi not to get issues with missing or testing dependencies comming from PyPi test repositories. The `--extra-index-url` is used to retrieve dependencies packages from the official PyPI not to get issues with missing or testing dependencies comming from PyPI test repositories.
## Continuous integration and delivery ## Continuous integration and delivery
### Own built Docker images ### Own built Docker images
...@@ -122,6 +122,6 @@ The `--extra-index-url` is used to retrieve dependencies packages from the offic ...@@ -122,6 +122,6 @@ The `--extra-index-url` is used to retrieve dependencies packages from the offic
- Tests on supported Python versions: - Tests on supported Python versions:
- Installation - Installation
- Pytest for v3.5, 3.6, 3.7, and 3.8 - Pytest for v3.5, 3.6, 3.7, and 3.8
- PyPi distribution - PyPI distribution
- test - test
- stable - stable
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment