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
a8088463
Unverified
Commit
a8088463
authored
Apr 07, 2022
by
Arun Babu Neelicattu
Committed by
GitHub
Apr 07, 2022
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
readme: do not repeat installation instructions (#5246)
parent
3780a727
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
3 additions
and
132 deletions
+3
-132
README.md
+3
-132
No files found.
README.md
View file @
a8088463
...
@@ -18,138 +18,9 @@ The [complete documentation](https://python-poetry.org/docs/) is available on th
...
@@ -18,138 +18,9 @@ The [complete documentation](https://python-poetry.org/docs/) is available on th
## Installation
## Installation
Poetry provides a custom installer that will install
`poetry`
isolated
Instructions on how to install
`poetry`
can be found
[
here
](
https://python-poetry.org/docs/master/#installation
)
.
from the rest of your system.
You can also refer
[
here
](
https://python-poetry.org/docs/master/#enable-tab-completion-for-bash-fish-or-zsh
)
for
information on how to enable tab completion in your environment.
### osx / linux / bashonwindows install instructions
```
bash
curl
-sSL
https://install.python-poetry.org | python3 -
```
### windows powershell install instructions
```
powershell
(
Invoke-WebRequest
-Uri https://install.python-poetry.org -UseBasicParsing
)
.Content | python -
```
**Warning**
: The previous
`get-poetry.py`
installer is now deprecated, if you are currently using it
you should migrate to the new, supported,
`install-poetry.py`
installer.
The installer installs the
`poetry`
tool to Poetry's
`bin`
directory. This location depends on your system:
-
`$HOME/.local/bin`
for Unix
-
`%APPDATA%\Python\Scripts`
on Windows
If this directory is not on your
`PATH`
, you will need to add it manually
if you want to invoke Poetry with simply
`poetry`
.
Alternatively, you can use the full path to
`poetry`
to use it.
Once Poetry is installed you can execute the following:
```
bash
poetry
--version
```
If you see something like
`Poetry (version 1.2.0)`
then you are ready to use Poetry.
If you decide Poetry isn't your thing, you can completely remove it from your system
by running the installer again with the
`--uninstall`
option or by setting
the
`POETRY_UNINSTALL`
environment variable before executing the installer.
```
bash
curl
-sSL
https://install.python-poetry.org | python3 -
--uninstall
curl
-sSL
https://install.python-poetry.org |
POETRY_UNINSTALL
=
1 python3 -
```
By default, Poetry is installed into the user's platform-specific home directory.
If you wish to change this, you may define the
`POETRY_HOME`
environment variable:
```
bash
curl
-sSL
https://install.python-poetry.org |
POETRY_HOME
=
/etc/poetry python3 -
```
If you want to install prerelease versions, you can do so by passing
`--preview`
option to
`install-poetry.py`
or by using the
`POETRY_PREVIEW`
environment variable:
```
bash
curl
-sSL
https://install.python-poetry.org | python3 -
--preview
curl
-sSL
https://install.python-poetry.org |
POETRY_PREVIEW
=
1 python3 -
```
Similarly, if you want to install a specific version, you can use
`--version`
option or the
`POETRY_VERSION`
environment variable:
```
bash
curl
-sSL
https://install.python-poetry.org | python3 -
--version
1.2.0
curl
-sSL
https://install.python-poetry.org |
POETRY_VERSION
=
1.2.0 python3 -
```
You can also install Poetry for a
`git`
repository by using the
`--git`
option:
```
bash
curl
-sSL
https://install.python-poetry.org | python3 -
--git
https://github.com/python-poetry/poetry.git@master
```
`
_Note that the installer does not support Python < 3.7._
## Updating `
poetry
`
Updating poetry to the latest stable version is as simple as calling the `
self update
` command.
**Warning**: Poetry versions installed using the now deprecated `
get-poetry.py
` installer will not be able to use this
command to update to 1.2 releases or later. Migrate to using the `
install-poetry.py
` installer or `
pipx
`.
```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 specific version you can pass it as an argument
to `
self update
`.
```bash
poetry self update 1.2.0
```
## Enable tab completion for Bash, Fish, or Zsh
`
poetry
` supports generating completion scripts for Bash, Fish, and Zsh.
See `
poetry help completions
` for full details, but the gist is as simple as using one of the following:
```bash
# Bash
poetry completions bash > /etc/bash_completion.d/poetry.bash-completion
# Fish
poetry completions fish > ~/.config/fish/completions/poetry.fish
# Zsh
poetry completions zsh > ~/.zfunc/_poetry
# Zsh (Oh-My-Zsh)
mkdir $ZSH_CUSTOM/plugins/poetry
poetry completions zsh > $ZSH_CUSTOM/plugins/poetry/_poetry
rm ~/.zcompdump*
# add `poetry` in the `plugins` list (https://github.com/ohmyzsh/ohmyzsh#enabling-plugins)
# Zsh (prezto)
poetry completions zsh > ~/.zprezto/modules/completion/external/src/_poetry
```
*Note:* you may need to restart your shell in order for the changes to take
effect.
For `
zsh
`, you must then add the following line in your `
~/.zshrc
` before
`
compinit
` (not for homebrew setup):
```zsh
fpath+=~/.zfunc
```
## Introduction
## Introduction
...
...
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