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
284888fd
Unverified
Commit
284888fd
authored
Apr 13, 2018
by
Sébastien Eustace
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Update README
parent
e907f409
Show whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
31 additions
and
15 deletions
+31
-15
README.md
+31
-15
No files found.
README.md
View file @
284888fd
...
...
@@ -7,12 +7,7 @@ ensuring you have the right stack everywhere.

Also, be aware that the features described here are the goal that this library is aiming
for and, as of now, not all of them are implemented (but most of them are).
The dependency management is done while the packaging and publishing are still at the beginning.
And finally, Poetry's code is only compatible with Python 3.6+ but it can manage
Python project's with previous versions without any problem.
It supports Python 2.7 and 3.4+.
## Installation
...
...
@@ -47,6 +42,27 @@ pip install --user poetry
Be aware, however, that it will also install poetry's dependencies
which might cause conflicts.
## Updating `poetry`
Updating poetry to the latest stable version is as simple as calling the
`self:update`
command.
```
bash
poetry self:update
```
If you want to install prerelease versions, you can use the
`--preview`
option.
```
bash
poetry self:update
--preview
```
And finally, if you want to install a spcific version you can pass it as an argument
to
`self:update`
.
```
bash
poetry self:update 0.8.0
```
### Enable tab completion for Bash, Fish, or Zsh
...
...
@@ -233,7 +249,7 @@ my-package
├── pyproject.toml
├── README.rst
├── my_package
└── __init__.py
│
└── __init__.py
└── tests
├── __init__.py
└── test_my_package
...
...
@@ -537,7 +553,7 @@ The globs specified in the exclude field identify a set of files that are not in
If a VCS is being used for a package, the exclude field will be seeded with the VCS’ ignore settings (`
.gitignore
` for git for example).
```toml
[
package
]
[
tool.poetry
]
# ...
include = ["package/**/*.py", "package/**/.c"]
```
...
...
@@ -642,7 +658,7 @@ To depend on a library located in a `git` repository,
the minimum information you need to specify is the location of the repository with the git key:
```toml
[dependencies]
[
tool.poetry.
dependencies]
requests = { git = "https://github.com/requests/requests.git" }
```
...
...
@@ -652,7 +668,7 @@ You can combine the `git` key with the `rev`, `tag`, or `branch` keys to specify
Here's an example of specifying that you want to use the latest commit on a branch named `
next
`:
```toml
[dependencies]
[
tool.poetry.
dependencies]
requests = { git = "https://github.com/kennethreitz/requests.git", branch = "next" }
```
...
...
@@ -661,12 +677,12 @@ requests = { git = "https://github.com/kennethreitz/requests.git", branch = "nex
You can also specify that a dependency should be installed only for specific Python versions:
```toml
[dependencies]
[
tool.poetry.
dependencies]
pathlib2 = { version = "^2.2", python = "~2.7" }
```
```toml
[dependencies]
[
tool.poetry.
dependencies]
pathlib2 = { version = "^2.2", python = ["~2.7", "^3.2"] }
```
...
...
@@ -675,7 +691,7 @@ pathlib2 = { version = "^2.2", python = ["~2.7", "^3.2"] }
This section describe the scripts or executable that will be installed when installing the package
```toml
[scripts]
[
tool.poetry.
scripts]
poetry = 'poetry:console.run'
```
...
...
@@ -720,9 +736,9 @@ Poetry supports arbitrary plugins wich work similarly to
To match the example in the setuptools documentation, you would use the following:
```toml
[plugins] # Optional super table
[
tool.poetry.
plugins] # Optional super table
[plugins."blogtool.parsers"]
[
tool.poetry.
plugins."blogtool.parsers"]
".rst" = "some_module::SomeClass"
``
`
...
...
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