Skip to content

Commit f7504db

Browse files
author
Jeremi Do Dinh
authored
PYSCAN-50 Document the setup of poetry to pull dependencies from private artifactory repo (#38)
1 parent 9345789 commit f7504db

File tree

2 files changed

+17
-2
lines changed

2 files changed

+17
-2
lines changed

README.md

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -139,7 +139,22 @@ Run `python src/py_sonar_scanner`
139139

140140
# Run the tests
141141

142-
Run `poetry install` to install the dependencies
142+
Run `poetry install` to install the dependencies. By default, the dependencies are installed from the Repox private repository.
143+
144+
To configure your credentials for Repox, go to your Repox user profile, and generate an identity token. Then set the following two environment variables:
145+
```markdown
146+
export POETRY_HTTP_BASIC_REPOX_USERNAME=<username>
147+
export POETRY_HTTP_BASIC_REPOX_PASSWORD=<password>
148+
```
149+
Where `<username>` is your Repox username and `<password>` is the identity token you generated.
150+
151+
If you wish to install the dependencies from the public PyPI repository, remove the following from `pyproject.toml`:
152+
```toml
153+
[[tool.poetry.source]]
154+
name = "repox"
155+
url = "https://repox.jfrog.io/artifactory/api/pypi/sonarsource-pypi/simple/"
156+
priority = "default"
157+
```
143158

144159
## Run the tests only
145160

poetry.lock

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)