Skip to content

Commit

Permalink
Merge remote-tracking branch 'upstream/main'
Browse files Browse the repository at this point in the history
  • Loading branch information
austinzh committed Jun 24, 2024
2 parents 9df61c7 + 5bab98c commit f25a81a
Show file tree
Hide file tree
Showing 27 changed files with 734 additions and 886 deletions.
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/---feature-request.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
name: "\U0001F381 Feature Request"
labels: ["kind/feature", "status/triage"]
description: "Did you find errors, omissions, or anything unintelligible in the documentation?"
description: "Want something new?"

body:
- type: markdown
Expand Down
6 changes: 4 additions & 2 deletions .github/workflows/tests.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ jobs:
tests-matrix:
# Use this matrix with multiple jobs defined in a reusable workflow:
uses: ./.github/workflows/.tests-matrix.yaml
name: ${{ matrix.os.name }} (Python ${{ matrix.python-version }})
name: "${{ matrix.os.name }} (Python ${{ matrix.python-version }})"
if: '!failure()'
needs:
- lockfile
Expand All @@ -117,10 +117,12 @@ jobs:
os:
- name: Ubuntu
image: ubuntu-22.04
- name: macOS
- name: macOS x86_64
image: macos-13
- name: Windows
image: windows-2022
- name: macOS aarch64
image: macos-14
python-version: ["3.8", "3.9", "3.10", "3.11", "3.12"]
fail-fast: false

Expand Down
2 changes: 1 addition & 1 deletion .pre-commit-hooks.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
entry: poetry check
language: python
pass_filenames: false
files: ^(.*/)?pyproject\.toml$
files: ^(.*/)?(poetry\.lock|pyproject\.toml)$

- id: poetry-lock
name: poetry-lock
Expand Down
104 changes: 53 additions & 51 deletions CHANGELOG.md

Large diffs are not rendered by default.

6 changes: 3 additions & 3 deletions docs/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -165,7 +165,7 @@ source, using a pre-release build, configuring a different installation location

By default, Poetry is installed into a platform and user-specific directory:

- `~/Library/Application Support/pypoetry` on MacOS.
- `~/Library/Application Support/pypoetry` on macOS.
- `~/.local/share/pypoetry` on Linux/Unix.
- `%APPDATA%\pypoetry` on Windows.

Expand Down Expand Up @@ -213,7 +213,7 @@ as `poetry`.

Alternatively, the full path to the `poetry` binary can always be used:

- `~/Library/Application Support/pypoetry/venv/bin/poetry` on MacOS.
- `~/Library/Application Support/pypoetry/venv/bin/poetry` on macOS.
- `~/.local/share/pypoetry/venv/bin/poetry` on Linux/Unix.
- `%APPDATA%\pypoetry\venv\Scripts\poetry` on Windows.
- `$POETRY_HOME/venv/bin/poetry` if `$POETRY_HOME` is set.
Expand All @@ -228,7 +228,7 @@ Once Poetry is installed and in your `$PATH`, you can execute the following:
poetry --version
```

If you see something like `Poetry (version 1.2.0)`, your install is ready to use!
If you see something like `Poetry (version 1.2.0)`, your installation is ready to use!
{{< /step >}}
{{< step >}}
**Update Poetry**
Expand Down
2 changes: 1 addition & 1 deletion docs/basic-usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ python = "^3.7.0"

we are allowing any version of Python 3 that is greater than `3.7.0`.

When you run `poetry install`, you must have access to some version of a Python inrepreter that satisfies this constraint available on your system.
When you run `poetry install`, you must have access to some version of a Python interpreter that satisfies this constraint available on your system.
Poetry will not install a Python interpreter for you.
If you use a tool like `pyenv`, you can use the experimental configuration value [`virtualenvs.prefer-active-python`]({{< relref "configuration/#virtualenvsprefer-active-python-experimental" >}}).

Expand Down
6 changes: 3 additions & 3 deletions docs/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -123,23 +123,23 @@ Poetry uses the following default directories:

- Linux: `$XDG_CONFIG_HOME/pypoetry` or `~/.config/pypoetry`
- Windows: `%APPDATA%\pypoetry`
- MacOS: `~/Library/Application Support/pypoetry`
- macOS: `~/Library/Application Support/pypoetry`

You can override the Config directory by setting the `POETRY_CONFIG_DIR` environment variable.

### Data Directory

- Linux: `$XDG_DATA_HOME/pypoetry` or `~/.local/share/pypoetry`
- Windows: `%APPDATA%\pypoetry`
- MacOS: `~/Library/Application Support/pypoetry`
- macOS: `~/Library/Application Support/pypoetry`

You can override the Data directory by setting the `POETRY_DATA_DIR` or `POETRY_HOME` environment variables. If `POETRY_HOME` is set, it will be given higher priority.

### Cache Directory

- Linux: `$XDG_CACHE_HOME/pypoetry` or `~/.cache/pypoetry`
- Windows: `%LOCALAPPDATA%\pypoetry`
- MacOS: `~/Library/Caches/pypoetry`
- macOS: `~/Library/Caches/pypoetry`

You can override the Cache directory by setting the `POETRY_CACHE_DIR` environment variable.

Expand Down
2 changes: 1 addition & 1 deletion docs/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@ constantly evolving, and this means that sometimes our documentation has gaps. Y
editing the existing content to be more accessible, or creating new content such as tutorials, FAQs, etc.

{{% note %}}
Github [Discussions](https://github.com/python-poetry/poetry/discussions) and the
GitHub [Discussions](https://github.com/python-poetry/poetry/discussions) and the
[kind/question label](https://github.com/python-poetry/poetry/labels/kind/question) are excellent sources for FAQ
candidates.
{{% /note %}}
Expand Down
10 changes: 5 additions & 5 deletions docs/repositories.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ poetry add --source foo private-package
Great, now all that is left is to publish your package. Assuming you'd want to share it privately
with your team, you can configure the
[Upload API](https://warehouse.pypa.io/api-reference/legacy.html#upload-api) endpoint for your
[publishable repository](#publishable-repository).
[publishable repository](#publishable-repositories).

```bash
poetry config repositories.foo https://pypi.example.org/legacy/
Expand Down Expand Up @@ -95,7 +95,7 @@ export POETRY_HTTP_BASIC_FOO_PASSWORD=<password>
```
{{% /note %}}

Now, all the is left is to build and publish your project using the
Now, all that is left is to build and publish your project using the
[`publish`]({{< relref "cli#publish" >}}).

```bash
Expand Down Expand Up @@ -378,7 +378,7 @@ package's versions, metadata, files, etc.

{{% note %}}

If the the package's published metadata is invalid, Poetry will download the available bdist/sdist to
If the package's published metadata is invalid, Poetry will download the available bdist/sdist to
inspect it locally to identify the relevant metadata.

{{% /note %}}
Expand Down Expand Up @@ -540,7 +540,7 @@ poetry config keyring.enabled false

{{% note %}}

Poetry will fallback to Pip style use of keyring so that backends like
Poetry will fall back to Pip style use of keyring so that backends like
Microsoft's [artifacts-keyring](https://pypi.org/project/artifacts-keyring/) get a chance to retrieve
valid credentials. It will need to be properly installed into Poetry's virtualenv,
preferably by installing a plugin.
Expand Down Expand Up @@ -591,7 +591,7 @@ poetry config certificates.foo.cert false
```

{{% warning %}}
Disabling certificate verification is not recommended as it is does not conform to security
Disabling certificate verification is not recommended as it does not conform to security
best practices.
{{% /warning %}}
{{% /note %}}
Expand Down
Loading

0 comments on commit f25a81a

Please sign in to comment.