Unverified Commit 2f129317 authored by Sébastien Eustace's avatar Sébastien Eustace
Browse files

Improve documentation

parent f65c9ee6
Loading
Loading
Loading
Loading
+56 −6
Changes for README.md: 56 added lines, 6 removed lines.
Original line number Diff line number Diff line
@@ -347,15 +347,19 @@ dependencies:
*  `-o|--outdated`: Show the latest version but only for packages that are outdated.


### package
### build

The `package` command builds the source and wheels archives.
The `build` command builds the source and wheels archives.

```bash
poetry build
```

Note that, at the moment, only pure python wheels are supported.

#### Options

* `--no-universal`: Do not build a universal wheel.
* `--no-wheels`: Build only the source package.
*  `-c|--clean`: Make a clean package.
* `-F|--format`: Limit the format to either wheel or sdist.

### publish

@@ -363,9 +367,55 @@ This command builds (if not already built) and publishes the package to the remo

It will automatically register the package before uploading if this is the first time it is submitted.

```bash
poetry publish
```

#### Options

* `-r|--repository`: The repository to register the package to (default: `pypi`).
Should match a repository name set by the [`config`](#config) command.


### `config`

The `config` command allows you to edit poetry config settings and repositories.

```bash
poetry config --list
```

#### Usage

````bash
poetry config [options] [setting-key] [setting-value1] ... [setting-valueN]
````

`setting-key` is a configuration option name and `setting-value1` is a configuration value.

#### Modifying repositories

In addition to modifying the config section,
the config command also supports making changes to the repositories section by using it the following way:

```bash
poetry config repositories.foo https://foo.bar/simple/
```

This will set the url for repository `foo` to `https://foo.bar/simple/`.

If you want to store your credentials for a specific repository, you can do so easily:

```bash
poetry config http-basic.foo username password
```

If you do not specify the password you will be prompted to write it.

#### Options

* `-r|--repository`: The repository to register the package to (default: `pypi`). Should match a section of your `~/.pypirc` file.
* `--unset`: Remove the configuration element named by `setting-key`.
* `--list`: Show the list of current config variables.

### search

+66 −8
Changes for README.rst: 66 added lines, 8 removed lines.
Original line number Diff line number Diff line
@@ -396,17 +396,21 @@ Options
-  ``-o|--outdated``: Show the latest version but only for packages that
   are outdated.

package
~~~~~~~
build
~~~~~

The ``build`` command builds the source and wheels archives.

.. code:: bash

    poetry build

The ``package`` command builds the source and wheels archives.
Note that, at the moment, only pure python wheels are supported.

Options
^^^^^^^

-  ``--no-universal``: Do not build a universal wheel.
-  ``--no-wheels``: Build only the source package.
-  ``-c|--clean``: Make a clean package.
-  ``-F|--format``: Limit the format to either wheel or sdist.

publish
~~~~~~~
@@ -417,12 +421,66 @@ the remote repository.
It will automatically register the package before uploading if this is
the first time it is submitted.

.. code:: bash

    poetry publish

Options
^^^^^^^

-  ``-r|--repository``: The repository to register the package to
   (default: ``pypi``). Should match a section of your ``~/.pypirc``
   file.
   (default: ``pypi``). Should match a repository name set by the
   ```config`` <#config>`__ command.

``config``
~~~~~~~~~~

The ``config`` command allows you to edit poetry config settings and
repositories.

.. code:: bash

    poetry config --list

Usage
^^^^^

.. code:: bash

    poetry config [options] [setting-key] [setting-value1] ... [setting-valueN]

``setting-key`` is a configuration option name and ``setting-value1`` is
a configuration value.

Modifying repositories
^^^^^^^^^^^^^^^^^^^^^^

In addition to modifying the config section, the config command also
supports making changes to the repositories section by using it the
following way:

.. code:: bash

    poetry config repositories.foo https://foo.bar/simple/

This will set the url for repository ``foo`` to
``https://foo.bar/simple/``.

If you want to store your credentials for a specific repository, you can
do so easily:

.. code:: bash

    poetry config http-basic.foo username password

If you do not specify the password you will be prompted to write it.

Options
^^^^^^^

-  ``--unset``: Remove the configuration element named by
   ``setting-key``.
-  ``--list``: Show the list of current config variables.

search
~~~~~~
+11 −0
Changes for poetry/console/commands/config.py: 11 added lines, 0 removed lines.
Original line number Diff line number Diff line
@@ -27,6 +27,17 @@ class ConfigCommand(Command):
        { --unset : Unset configuration setting }
    """

    help = """This command allows you to edit the poetry config settings and repositories..

To add a repository:

    <comment>poetry repositories.foo https://bar.com/simple/</comment>

To remove a repository (repo is a short alias for repositories):

    <comment>poetry --unset repo.foo</comment>
"""

    def __init__(self):
        super().__init__()