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
387d46a0
Unverified
Commit
387d46a0
authored
May 07, 2018
by
Sébastien Eustace
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Update documentation
parent
ad69ca8c
Hide whitespace changes
Inline
Side-by-side
Showing
4 changed files
with
38 additions
and
0 deletions
+38
-0
docs/docs/basic-usage.md
+4
-0
docs/docs/cli.md
+17
-0
docs/docs/repositories.md
+3
-0
docs/docs/versions.md
+14
-0
No files found.
docs/docs/basic-usage.md
View file @
387d46a0
...
...
@@ -157,3 +157,7 @@ or create a brand new one for you to always work isolated from your global Pytho
The created virtualenv will use the Python executable for which
`poetry` has been installed.
What this means is if you project is Python 2.7 only you should
install `poetry` for you global Python 2.7 executable and use
it to manage your project.
docs/docs/cli.md
View file @
387d46a0
...
...
@@ -121,9 +121,26 @@ poetry will choose a suitable one based on the available package versions.
poetry add requests pendulum
```
You can also add
`git`
dependencies:
```
bash
poetry add pendulum
--git
https://github.com/sdispater/pendulum.git
```
or make them point to a local directory or file:
```
bash
poetry add my-package
--path
../my-package/
poetry add my-package
--path
../my-package/dist/my-package-0.1.0.tar.gz
poetry add my-package
--path
../my-package/dist/my_package-0.1.0.whl
```
### Options
*
`--dev (-D)`
: Add package as development dependency.
*
`--git`
: The url of the Git repository.
*
`--path`
: The path to a dependency.
*
`--extras (-E)`
: Extras to activate for the dependency.
*
`--optional`
: Add as an optional dependency.
*
`--dry-run`
: Outputs the operations but will not execute anything (implicitly enables --verbose).
...
...
docs/docs/repositories.md
View file @
387d46a0
...
...
@@ -45,6 +45,9 @@ If you do not specify the password you will be prompted to write it.
```bash
poetry config http-basic.pypi username password
```
You can also specify the username and password when using the
`publish`
command
with the
`--username`
and
`--password`
options.
### Install dependencies from a private repository
...
...
docs/docs/versions.md
View file @
387d46a0
...
...
@@ -94,6 +94,20 @@ Here's an example of specifying that you want to use the latest commit on a bran
requests
=
{
git
=
"https://github.com/kennethreitz/requests.git"
,
branch
=
"next"
}
```
### `path` dependencies
To depend on a library located in a local directory or file,
you can use the
`path`
property:
```
toml
[tool.poetry.dependencies]
# directory
my-package
=
{
path
=
"../my-package/"
}
# file
my-package
=
{
path
=
"../my-package/dist/my-package-0.1.0.tar.gz"
}
```
### Python restricted dependencies
You can also specify that a dependency should be installed only for specific Python versions:
...
...
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