Skip to content

Commit

Permalink
docs: correct/update poetry config
Browse files Browse the repository at this point in the history
  • Loading branch information
noelmcloughlin committed Aug 18, 2024
1 parent b414054 commit 7e56fb7
Showing 1 changed file with 10 additions and 12 deletions.
22 changes: 10 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,20 +18,22 @@ The following are required and recommended tools for using this cookiecutter and

* **Poetry**

Poetry is a Python project management tool. You will use it in your generated project to manage dependencies and build distribution files. If you have pipx installed you can install Poetry by running:
Poetry is a Python project management tool. You will use it in your generated project to manage dependencies and build distribution files. If you have pipx installed ([alternative installation methods](https://python-poetry.org/docs/#installation) are available) you can install Poetry by running:
```shell
pipx install poetry
```
For other installation methods see: https://python-poetry.org/docs/#installation

* **Poetry behind firewalls**
* **Poetry user configuration**

In sandboxed environments (proxy or internal repositories), you must configure poetry source in `~/.config/pypoetry/pyproject.toml` to allow software installation, illustrated below:
This project manages project-level configuration. User-level [configuration](https://python-poetry.org/docs/configuration/), if needed, is your responsibility.

In sandboxed environments, update `$HOME/.config/pypoetry/config.toml` with your private [repository](https://python-poetry.org/docs/repositories/), if needed:
```shell
# example
[[tool.poetry.source]]
name = "myproxy"
url = "https://repo.example.com/repository/pypi-all/simple"
priority = "default"
name = "privateproxy"
url = "https://pypi-proxy.myorg.com/repository/pypi-all/simple"
priority = "explicit"
```

* **Poetry Dynamic Versioning Plugin**:
Expand Down Expand Up @@ -113,11 +115,7 @@ Optionally customize your project if needed:

* pass arguments to linkml generators via 'config.yaml' configuration file;
* pass supported environment variables via '.env.public' configuration file;
* configure proxy server via project configuration file (as illustrated):
```bash
git init
poetry source add --priority=default myproxy https://repo.example.com/repository/pypi-all/simple
```
* add private repository for poetry (see "poetry user configuration" section above);

Setup your project
```bash
Expand Down

0 comments on commit 7e56fb7

Please sign in to comment.