Loading docs/docs/basic-usage.md +3 −2 Original line number Diff line number Diff line Loading @@ -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` file. Any case of missing dependencies should be reported to https://github.com/sdispater/poetry/issues and on the repository of the main package. Any case of missing dependencies should be reported to the offical [repository](https://github.com/sdispater/poetry/issues) and on the repository of the package with missing dependencies. ### Version constraints Loading docs/docs/index.md +23 −1 Original line number Diff line number Diff line Loading @@ -6,7 +6,7 @@ It allows you to declare the libraries your project depends on and it will manag ## 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. Loading Loading @@ -44,3 +44,25 @@ python get-poetry.py --version 0.7.0 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 ``` docs/docs/pyproject.md 0 → 100644 +116 −0 Original line number Diff line number Diff line # 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 +1 −0 Original line number Diff line number Diff line Loading @@ -14,6 +14,7 @@ pages: - Commands: cli.md - Repositories: repositories.md - Versions: versions.md - The pyproject.toml file: pyproject.md markdown_extensions: - codehilite Loading Loading
docs/docs/basic-usage.md +3 −2 Original line number Diff line number Diff line Loading @@ -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` file. Any case of missing dependencies should be reported to https://github.com/sdispater/poetry/issues and on the repository of the main package. Any case of missing dependencies should be reported to the offical [repository](https://github.com/sdispater/poetry/issues) and on the repository of the package with missing dependencies. ### Version constraints Loading
docs/docs/index.md +23 −1 Original line number Diff line number Diff line Loading @@ -6,7 +6,7 @@ It allows you to declare the libraries your project depends on and it will manag ## 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. Loading Loading @@ -44,3 +44,25 @@ python get-poetry.py --version 0.7.0 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 ```
docs/docs/pyproject.md 0 → 100644 +116 −0 Original line number Diff line number Diff line # 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 +1 −0 Original line number Diff line number Diff line Loading @@ -14,6 +14,7 @@ pages: - Commands: cli.md - Repositories: repositories.md - Versions: versions.md - The pyproject.toml file: pyproject.md markdown_extensions: - codehilite Loading
