Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: Add warning about saving credentials #5726

Merged
merged 4 commits into from
May 31, 2022
Merged

docs: Add warning about saving credentials #5726

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
4a13d2a
docs: Add warning about saving credentials
Secrus May 30, 2022
ff3b5f6
Update docs/repositories.md
Secrus May 30, 2022
9bb9bdd
Update docs/repositories.md
Secrus May 31, 2022
2b3e2c2
Update docs/repositories.md
neersighted May 31, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 10 additions & 6 deletions docs/repositories.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,9 +39,13 @@ poetry source add foo https://pypi.example.org/simple/
Then, assuming the repository requires authentication, configure credentials for it.

```bash
poetry config http-basic.foo username password
poetry config http-basic.foo <username> <password>
```

{{% warning %}}
Depending on your systems configuration, credentials might be saved in your command lines history.
Secrus marked this conversation as resolved.
Show resolved Hide resolved
{{% /warning %}}

Once this is done, you can add dependencies to your project from this source.

```bash
Expand All @@ -66,7 +70,7 @@ recommended to use a different name for your publishing repository.

```bash
poetry config repositories.foo-pub https://pypi.example.org/legacy/
poetry config http-basic.foo-pub username password
poetry config http-basic.foo-pub <username> <password>
```

{{% /note %}}
Expand Down Expand Up @@ -303,7 +307,7 @@ well as the path (`/legacy`) are different to it's simple API (`https://test.pyp
If you want to store your credentials for a specific repository, you can do so easily:

```bash
poetry config http-basic.foo username password
poetry config http-basic.foo <username> <password>
```

If you do not specify the password you will be prompted to write it.
Expand All @@ -324,7 +328,7 @@ If you still want to use your username and password, you can do so with the foll
call to `config`.

```bash
poetry config http-basic.pypi username password
poetry config http-basic.pypi <username> <password>
```

{{% /note %}}
Expand Down Expand Up @@ -355,8 +359,8 @@ Alternatively, you can use environment variables to provide the credentials:

```bash
export POETRY_PYPI_TOKEN_PYPI=my-token
export POETRY_HTTP_BASIC_PYPI_USERNAME=username
export POETRY_HTTP_BASIC_PYPI_PASSWORD=password
export POETRY_HTTP_BASIC_PYPI_USERNAME=<username>
export POETRY_HTTP_BASIC_PYPI_PASSWORD=<password>
```

See [Using environment variables]({{< relref "configuration#using-environment-variables" >}}) for more information
Expand Down