Skip to content

Commit

Permalink
README: Document ASDF_POETRY_INSTALL_URL
Browse files Browse the repository at this point in the history
  • Loading branch information
tony committed Nov 28, 2021
1 parent c428bfd commit c1b5565
Showing 1 changed file with 23 additions and 0 deletions.
23 changes: 23 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,29 @@ asdf plugin-add poetry https://github.com/asdf-community/asdf-poetry.git
Check [asdf](https://github.com/asdf-vm/asdf) readme for instructions on how to
install & manage versions.

### Overriding installer

`ASDF_POETRY_INSTALL_URL` is an optional variable you can specific to point to
the hosted installer of your choosing, e.g. `get-poetry.py` or the new `install-poetry.py`
(compatible with [1.1.7+](https://github.com/python-poetry/poetry/releases/tag/1.1.7) and
[default in 1.2](https://python-poetry.org/blog/announcing-poetry-1.2.0a1/#deprecation-of-the-get-poetrypy-script)).

For example, to force `install-poetry.py` on 1.1.9:

```
ASDF_POETRY_INSTALL_URL=https://install.python-poetry.org asdf install poetry 1.1.9
```

To force `install-poetry.py` for all `asdf-poetry` versions, you can export this in your
`.bashrc`, `.zshrc`, etc:

```
export ASDF_POETRY_INSTALL_URL=https://install.python-poetry.org
```

Doing so is not recommended and may result in poetry installations which
disregard the `asdf-python` plugin. See [issue #10](https://github.com/asdf-community/asdf-poetry/issues/10)

## License

Licensed under the
Expand Down

0 comments on commit c1b5565

Please sign in to comment.