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
e907f409
Unverified
Commit
e907f409
authored
Apr 13, 2018
by
Sébastien Eustace
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Update documentation
parent
5b1f55e1
Show whitespace changes
Inline
Side-by-side
Showing
4 changed files
with
143 additions
and
3 deletions
+143
-3
docs/docs/basic-usage.md
+3
-2
docs/docs/index.md
+23
-1
docs/docs/pyproject.md
+116
-0
docs/mkdocs.yml
+1
-0
No files found.
docs/docs/basic-usage.md
View file @
e907f409
...
@@ -85,8 +85,9 @@ It will automatically find a suitable version constraint.
...
@@ -85,8 +85,9 @@ It will automatically find a suitable version constraint.
In this case you will need to specify the missing dependencies in you `pyproject.toml`
In this case you will need to specify the missing dependencies in you `pyproject.toml`
file.
file.
Any case of missing dependencies should be reported to https://github.com/sdispater/poetry/issues
Any case of missing dependencies should be reported to
and on the repository of the main package.
the offical [repository](https://github.com/sdispater/poetry/issues)
and on the repository of the package with missing dependencies.
### Version constraints
### Version constraints
...
...
docs/docs/index.md
View file @
e907f409
...
@@ -6,7 +6,7 @@ It allows you to declare the libraries your project depends on and it will manag
...
@@ -6,7 +6,7 @@ It allows you to declare the libraries your project depends on and it will manag
## System requirements
## System requirements
Poetry requires Python
3.6
+. It is multi-platform and the goal is to make it work equally well
Poetry requires Python
2.7 or 3.4
+. It is multi-platform and the goal is to make it work equally well
on Windows, Linux and OSX.
on Windows, Linux and OSX.
...
@@ -44,3 +44,25 @@ python get-poetry.py --version 0.7.0
...
@@ -44,3 +44,25 @@ python get-poetry.py --version 0.7.0
Be aware, however, that it will also install poetry's dependencies
Be aware, however, that it will also install poetry's dependencies
which might cause conflicts.
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
```
docs/docs/pyproject.md
0 → 100644
View file @
e907f409
# The `pyproject.toml` file
The
`tool.poetry`
section of the
`pyproject.toml`
file is composed of multiple sections.
## name
The name of the package.
**Required**
## version
The version of the package.
**Required**
This should follow
[
semantic versioning
](
http://semver.org/
)
. However it will not be enforced and you remain
free to follow another specification.
## description
A short description of the package.
**Required**
## license
The license of the package.
The recommended notation for the most common licenses is (alphabetical):
*
Apache-2.0
*
BSD-2-Clause
*
BSD-3-Clause
*
BSD-4-Clause
*
GPL-2.0
*
GPL-2.0+
*
GPL-3.0
*
GPL-3.0+
*
LGPL-2.1
*
LGPL-2.1+
*
LGPL-3.0
*
LGPL-3.0+
*
MIT
Optional, but it is highly recommended to supply this.
More identifiers are listed at the
[
SPDX Open Source License Registry
](
https://www.spdx.org/licenses/
)
.
## authors
The authors of the package. This is a list of authors and should contain at least one author.
Authors must be in the form
`name <email>`
.
## readme
The readme file of the package.
**Required**
The file can be either
`README.rst`
or
`README.md`
.
## homepage
An URL to the website of the project.
**Optional**
## repository
An URL to the repository of the project.
**Optional**
## documentation
An URL to the documentation of the project.
**Optional**
## keywords
A list of keywords (max: 5) that the package is related to.
**Optional**
## include and exclude
A list of patterns that will be included in the final package.
You can explicitly specify to Poetry that a set of globs should be ignored or included for the purposes of packaging.
The globs specified in the exclude field identify a set of files that are not included when a package is built.
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]
# ...
include
=
[
"package/**/*.py"
,
"package/**/.c"
]
```
```
toml
exclude
=
["package/excluded.py"]
```
### `dependencies` and `dev-dependencies`
Poetry is configured to look for dependencies on
[
PyPi
](
https://pypi.org
)
by default.
Only the name and a version string are required in this case.
```
toml
[tool.poetry.dependencies]
requests
=
"^2.13.0"
```
If you want to use a private repository, you can add it to your
`pyproject.toml`
file, like so:
```
toml
[[tool.poetry.source]]
name
=
'private'
url
=
'http://example.com/simple'
```
!!!note
Be aware that declaring the python version for which your package
is compatible is mandatory:
```toml
[tool.poetry.dependencies]
python = "^3.6"
```
docs/mkdocs.yml
View file @
e907f409
...
@@ -14,6 +14,7 @@ pages:
...
@@ -14,6 +14,7 @@ pages:
-
Commands
:
cli.md
-
Commands
:
cli.md
-
Repositories
:
repositories.md
-
Repositories
:
repositories.md
-
Versions
:
versions.md
-
Versions
:
versions.md
-
The pyproject.toml file
:
pyproject.md
markdown_extensions
:
markdown_extensions
:
-
codehilite
-
codehilite
...
...
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