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
01fbecd7
Unverified
Commit
01fbecd7
authored
Mar 16, 2018
by
Sébastien Eustace
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Update documentation
parent
9579de75
Show whitespace changes
Inline
Side-by-side
Showing
2 changed files
with
35 additions
and
0 deletions
+35
-0
docs/docs/basic-usage.md
+16
-0
docs/docs/cli.md
+19
-0
No files found.
docs/docs/basic-usage.md
View file @
01fbecd7
...
...
@@ -144,3 +144,19 @@ and update the lock file with the new versions.
Poetry will display a Warning when executing an install command if `pyproject.lock` and `pyproject.toml`
are not synchronized.
## Poetry and virtualenvs
When you execute the
`install`
command (or any other "install" commands like
`add`
or
`remove`
),
Poetry will check if it's currently inside a virtualenv and, if not, will use an existing one
or create a brand new one for you to always work isolated from your global Python installation.
!!!warning
Since Poetry is 3.6+ only, it will create virtualenvs
using the standard library `venv` module.
So if you want to work with a previous Python version in your
project, you will need to create your own virtualenvs using, for instance,
[pew](https://github.com/berdario/pew).
docs/docs/cli.md
View file @
01fbecd7
...
...
@@ -243,6 +243,25 @@ If you do not specify the password you will be prompted to write it.
* `
--unset
`: Remove the configuration element named by `
setting-key
`.
* `
--list
`: Show the list of current config variables.
## run
The `
run
` command executes the given command inside the project's virtualenv.
```bash
poetry run python -V
```
Note that this command has no option.
## check
The `
check
` command validate the structure of the `
pyproject.toml
` file
and returns a detailed report is there are any errors.
```bash
poetry check
```
## search
This command searches for packages on a remote index.
...
...
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