Commit ae3ba06c by Kelton Karboviak Committed by Sébastien Eustace

Fix typos (#643)

parent be8425d1
...@@ -159,13 +159,13 @@ or create a brand new one for you to always work isolated from your global Pytho ...@@ -159,13 +159,13 @@ or create a brand new one for you to always work isolated from your global Pytho
To create the virtualenv for the current project, Poetry will use To create the virtualenv for the current project, Poetry will use
the currently activated Python version. the currently activated Python version.
To easily switch between Python versions, it is recommended to To easily switch between Python versions, it is recommended to
use [pyenv](https://github.com/pyenv/pyenv) or similar tools. use [pyenv](https://github.com/pyenv/pyenv) or similar tools.
For instance, if your project is Python 2.7 only, a standard workflow For instance, if your project is Python 2.7 only, a standard workflow
would be: would be:
```bash ```bash
pyenv install 2.7.15 pyenv install 2.7.15
pyenv local 2.7.15 # Activate Python 2.7 for the current project pyenv local 2.7.15 # Activate Python 2.7 for the current project
......
...@@ -190,7 +190,7 @@ poetry add my-package --path ../my-package/dist/my_package-0.1.0.whl ...@@ -190,7 +190,7 @@ poetry add my-package --path ../my-package/dist/my_package-0.1.0.whl
## remove ## remove
The `remove` command removes a package from the current The `remove` command removes a package from the current
list of installed packages list of installed packages.
```bash ```bash
poetry remove pendulum poetry remove pendulum
...@@ -296,7 +296,7 @@ The `run` command executes the given command inside the project's virtualenv. ...@@ -296,7 +296,7 @@ The `run` command executes the given command inside the project's virtualenv.
poetry run python -V poetry run python -V
``` ```
It can also executes one of the scripts defined in `pyproject.toml`. It can also execute one of the scripts defined in `pyproject.toml`.
So, if you have a script defined like this: So, if you have a script defined like this:
...@@ -315,9 +315,9 @@ Note that this command has no option. ...@@ -315,9 +315,9 @@ Note that this command has no option.
## shell ## shell
The `shell` command spawns a shell, The `shell` command spawns a shell,
according to the `$SHELL` environment variable, according to the `$SHELL` environment variable,
within the virtual environment. within the virtual environment.
If one doesn't exist yet, it will be created. If one doesn't exist yet, it will be created.
```bash ```bash
...@@ -326,7 +326,7 @@ poetry shell ...@@ -326,7 +326,7 @@ poetry shell
## check ## check
The `check` command validate the structure of the `pyproject.toml` file The `check` command validates the structure of the `pyproject.toml` file
and returns a detailed report if there are any errors. and returns a detailed report if there are any errors.
```bash ```bash
......
...@@ -8,7 +8,7 @@ This file can typically be found in one of the following directories: ...@@ -8,7 +8,7 @@ This file can typically be found in one of the following directories:
- Windows: `C:\Users\<username>\AppData\Roaming\pypoetry` - Windows: `C:\Users\<username>\AppData\Roaming\pypoetry`
For Unix, we follow the XDG spec and support `$XDG_CONFIG_HOME`. For Unix, we follow the XDG spec and support `$XDG_CONFIG_HOME`.
That means, by default `~/.config/pypoetry` That means, by default `~/.config/pypoetry`.
## Available settings ## Available settings
......
...@@ -11,7 +11,7 @@ and, as such, they are not available via the PyPI JSON API. At this point, Poetr ...@@ -11,7 +11,7 @@ and, as such, they are not available via the PyPI JSON API. At this point, Poetr
but downloading the packages and inspect them to get the necessary information. This is an expensive but downloading the packages and inspect them to get the necessary information. This is an expensive
operation, both in bandwidth and time, which is why it seems this is a long process. operation, both in bandwidth and time, which is why it seems this is a long process.
At the moment there is not way around it. At the moment there is no way around it.
!!!note !!!note
...@@ -38,7 +38,7 @@ The `^` operator works very well with libraries following [semantic versioning]( ...@@ -38,7 +38,7 @@ The `^` operator works very well with libraries following [semantic versioning](
Yes. By using the [isolated builds](https://tox.readthedocs.io/en/latest/config.html#conf-isolated_build) `tox` provides, Yes. By using the [isolated builds](https://tox.readthedocs.io/en/latest/config.html#conf-isolated_build) `tox` provides,
you can use it in combination with the PEP 517 compliant build system provided by Poetry. you can use it in combination with the PEP 517 compliant build system provided by Poetry.
So, in your `pyproject.toml` file add this section if does not already exists: So, in your `pyproject.toml` file, add this section if it does not already exist:
```toml ```toml
[build-system] [build-system]
......
...@@ -73,7 +73,7 @@ POETRY_VERSION=0.12.0 python get-poetry.py ...@@ -73,7 +73,7 @@ POETRY_VERSION=0.12.0 python get-poetry.py
Using alternative installation methods will make Poetry always Using alternative installation methods will make Poetry always
use the Python version for which it has been installed to create use the Python version for which it has been installed to create
virtualenvs. virtualenvs.
So, you will need to install Poetry for each Python version you So, you will need to install Poetry for each Python version you
want to use and switch between them. want to use and switch between them.
......
...@@ -68,7 +68,7 @@ Once this is done, your library will be available to anyone. ...@@ -68,7 +68,7 @@ Once this is done, your library will be available to anyone.
## Publishing to a private repository ## Publishing to a private repository
Sometimes, you may want to keep your library private but also being accessible to you team. Sometimes, you may want to keep your library private but also being accessible to your team.
In this case, you will need to use a private repository. In this case, you will need to use a private repository.
......
...@@ -119,7 +119,7 @@ packages = [ ...@@ -119,7 +119,7 @@ packages = [
**explicitly** specify the "default" package. **explicitly** specify the "default" package.
For instance, if you have a package named `my_package` and you want to also include For instance, if you have a package named `my_package` and you want to also include
another package named `extra_package`, you will need to specify `my_package` explicitely: another package named `extra_package`, you will need to specify `my_package` explicitly:
```toml ```toml
packages = [ packages = [
...@@ -132,7 +132,7 @@ packages = [ ...@@ -132,7 +132,7 @@ packages = [
Poetry is clever enough to detect Python subpackages. Poetry is clever enough to detect Python subpackages.
So, if you only have to specify the directory where you root package resides. Thus, you only have to specify the directory where your root package resides.
## include and exclude ## include and exclude
......
...@@ -8,7 +8,7 @@ for package installation and publishing. ...@@ -8,7 +8,7 @@ for package installation and publishing.
So, when you add dependencies to your project, Poetry will assume they are available So, when you add dependencies to your project, Poetry will assume they are available
on PyPI. on PyPI.
This represent most cases and will likely be enough for most users. This represents most cases and will likely be enough for most users.
## Using a private repository ## Using a private repository
...@@ -41,11 +41,11 @@ If you do not specify the password you will be prompted to write it. ...@@ -41,11 +41,11 @@ If you do not specify the password you will be prompted to write it.
To publish to PyPI, you can set your credentials for the repository To publish to PyPI, you can set your credentials for the repository
named `pypi`: named `pypi`:
```bash ```bash
poetry config http-basic.pypi username password poetry config http-basic.pypi username password
``` ```
You can also specify the username and password when using the `publish` command You can also specify the username and password when using the `publish` command
with the `--username` and `--password` options. with the `--username` and `--password` options.
...@@ -66,5 +66,5 @@ From now on, Poetry will also look for packages in your private repository. ...@@ -66,5 +66,5 @@ From now on, Poetry will also look for packages in your private repository.
If your private repository requires HTTP Basic Auth be sure to add the username and If your private repository requires HTTP Basic Auth be sure to add the username and
password to your `http-basic` config using the example above (be sure to use the password to your `http-basic` config using the example above (be sure to use the
same name than in the `tool.poetry.source` section). Poetry will use these values same name that is in the `tool.poetry.source` section). Poetry will use these values
to authenticate to your private repository when downloading or looking for packages. to authenticate to your private repository when downloading or looking for packages.
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment