Skip to content
Projects
Groups
Snippets
Help
This project
Loading...
Sign in / Register
Toggle navigation
P
python-poetry
Overview
Overview
Details
Activity
Cycle Analytics
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Charts
Issues
0
Issues
0
List
Board
Labels
Milestones
Merge Requests
0
Merge Requests
0
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Charts
Wiki
Wiki
Snippets
Snippets
Members
Collapse sidebar
Close sidebar
Activity
Graph
Charts
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
open
python-poetry
Commits
29d4f078
Commit
29d4f078
authored
Jun 25, 2018
by
Cauê Baasch de Souza
Committed by
Sébastien Eustace
Jun 25, 2018
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Document available settings for poetry config (#232)
parent
7d438b85
Show whitespace changes
Inline
Side-by-side
Showing
3 changed files
with
35 additions
and
19 deletions
+35
-19
docs/docs/cli.md
+1
-19
docs/docs/configuration.md
+33
-0
docs/mkdocs.yml
+1
-0
No files found.
docs/docs/cli.md
View file @
29d4f078
...
...
@@ -258,25 +258,7 @@ poetry config [options] [setting-key] [setting-value1] ... [setting-valueN]
```
`
`
setting-key
` is a configuration option name and `
setting-value1
` is a configuration value.
### Modifying repositories
In addition to modifying the config section,
the config command also supports making changes to the repositories section by using it the following way:
```bash
poetry config repositories.foo https://foo.bar/simple/
```
This will set the url for repository `
foo
` to `
https://foo.bar/simple/
`.
If you want to store your credentials for a specific repository, you can do so easily:
```bash
poetry config http-basic.foo username password
```
If you do not specify the password you will be prompted to write it.
See [Configuration](/configuration/) for all available settings.
### Options
...
...
docs/docs/configuration.md
0 → 100644
View file @
29d4f078
# Configuration
Poetry can be configured via the
`config`
command (
[
see more about its usage here
](
/cli/#config
)
)
or directly in the
`config.toml`
file that will be automatically be created when you first run that command.
This file can typically be found in one of the following directories:
-
macOS:
`~/Library/Application Support/pypoetry`
-
Windows:
`C:\Users\<username>\AppData\Roaming\pypoetry`
For Unix, we follow the XDG spec and support
`$XDG_CONFIG_HOME`
.
That means, by default
`~/.config/pypoetry`
## Available settings
### `settings.virtualenvs.create`: boolean
Create a new virtualenv if one doesn't already exist.
Defaults to
`true`
.
### `settings.virtualenvs.in-project`: boolean
Create the virtualenv inside the project's root directory.
Defaults to
`false`
.
### `settings.virtualenvs.path`: string
Directory where virtualenvs will be created.
Defaults to one of the following directories:
-
macOS:
`~/Library/Caches/pypoetry/virtualenvs`
-
Windows:
`C:\Users\<username>\AppData\Local\pypoetry\Cache/virtualenvs`
-
Unix:
`~/.cache/pypoetry/virtualenvs`
### `repository.<name>`: string
Set a new alternative repository. See
[
Repositories
](
/repositories/
)
for more information.
docs/mkdocs.yml
View file @
29d4f078
...
...
@@ -12,6 +12,7 @@ pages:
-
Basic Usage
:
basic-usage.md
-
Libraries
:
libraries.md
-
Commands
:
cli.md
-
Configuration
:
configuration.md
-
Repositories
:
repositories.md
-
Versions
:
versions.md
-
The pyproject.toml file
:
pyproject.md
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment