PKG-INFO 13.1 KB
Newer Older
1
Metadata-Version: 1.2
2
Name: twine
3 4 5
Version: 1.10.0
Summary: Collection of utilities for publishing packages on PyPI
Home-page: http://twine.readthedocs.io/
6 7 8
Author: Donald Stufft and individual contributors
Author-email: donald@stufft.io
License: Apache License, Version 2.0
9 10 11 12
Project-URL: Packaging tutorial, https://packaging.python.org/tutorials/distributing-packages/
Project-URL: Twine source, https://github.com/pypa/twine/
Project-URL: Twine documentation, https://twine.readthedocs.io/en/latest/
Description-Content-Type: UNKNOWN
13 14 15
Description: twine
        =====
        
16
        .. rtd-inclusion-marker-do-not-remove
17
        
18 19 20
        Twine is `a utility`_ for `publishing`_ packages on `PyPI`_.
        
        Currently it only supports registering `projects`_ and uploading `distributions`_.
21 22 23 24 25
        
        
        Why Should I Use This?
        ----------------------
        
26 27 28 29 30 31
        The goal of ``twine`` is to improve PyPI interaction by improving
        security and testability.
        
        The biggest reason to use ``twine`` is that it securely authenticates you to PyPI
        over HTTPS using a verified connection, while ``python setup.py upload`` `only
        recently stopped using HTTP <https://bugs.python.org/issue12226>`_ in Python
32 33
        2.7.9+ and Python 3.2+. This means anytime you use ``python setup.py upload``
        with an older Python version, you expose your username and password to being
34
        easily sniffed. Twine uses only verified TLS to upload to PyPI, protecting your
35
        credentials from theft.
36
        
37
        Secondly, it allows you to precreate your distribution files.
38 39 40 41 42
        ``python setup.py upload`` only allows you to upload something that you've
        created in the same command invocation. This means that you cannot test the
        exact file you're going to upload to PyPI to ensure that it works before
        uploading it.
        
43 44 45 46 47
        Finally, it allows you to pre-sign your files and pass the ``.asc``
        files into the command line invocation (``twine upload
        twine-1.0.1.tar.gz twine-1.0.1.tar.gz.asc``). This enables you to be
        assured that you're typing your ``gpg`` passphrase into ``gpg`` itself
        and not anything else, since *you* will be the one directly executing
48 49 50 51 52 53
        ``gpg --detach-sign -a <filename>``.
        
        
        Features
        --------
        
54 55
        - Verified HTTPS connections
        - Uploading doesn't require executing ``setup.py``
56
        - Uploading files that have already been created, allowing testing of
57
          distributions before release
58
        - Supports uploading any packaging format (including wheels)
59 60 61 62 63
        
        
        Installation
        ------------
        
64
        .. code-block:: console
65 66 67 68 69 70 71 72 73
        
            $ pip install twine
        
        
        Usage
        -----
        
        1. Create some distributions in the normal way:
        
74
           .. code-block:: console
75
        
76
               $ python setup.py sdist bdist_wheel
77
        
78
        2. Upload with ``twine``:
79
        
80
           .. code-block:: console
81 82 83
        
               $ twine upload dist/*
        
84
        3. Done!
85
        
86 87
        More documentation on using ``twine`` to upload packages to PyPI is in
        the `Python Packaging User Guide`_.
88 89 90
        
        
        Options
91
        ^^^^^^^
92
        
93
        .. code-block:: console
94 95
        
            $ twine upload -h
96
        
97 98 99 100
            usage: twine upload [-h] [-r REPOSITORY] [--repository-url REPOSITORY_URL]
                                [-s] [--sign-with SIGN_WITH] [-i IDENTITY] [-u USERNAME]
                                [-p PASSWORD] [-c COMMENT] [--config-file CONFIG_FILE]
                                [--skip-existing] [--cert path] [--client-cert path]
101 102 103 104 105 106 107 108 109 110
                                dist [dist ...]
        
            positional arguments:
              dist                  The distribution files to upload to the repository,
                                    may additionally contain a .asc file to include an
                                    existing signature with the file upload
        
            optional arguments:
              -h, --help            show this help message and exit
              -r REPOSITORY, --repository REPOSITORY
111 112 113 114 115 116 117 118 119 120
                                    The repository to upload the package to. Can be a
                                    section in the config file or a full URL to the
                                    repository (default: pypi). (Can also be set via
                                    TWINE_REPOSITORY environment variable)
              --repository-url REPOSITORY_URL
                                    The repository URL to upload the package to. This can
                                    be specified with --repository because it will be used
                                    if there is no configuration for the value passed to
                                    --repository. (Can also be set via
                                    TWINE_REPOSITORY_URL environment variable.)
121
              -s, --sign            Sign files to upload using gpg
122 123
              --sign-with SIGN_WITH
                                    GPG program used to sign uploads (default: gpg)
124 125 126
              -i IDENTITY, --identity IDENTITY
                                    GPG identity used to sign files
              -u USERNAME, --username USERNAME
127 128
                                    The username to authenticate to the repository as (can
                                    also be set via TWINE_USERNAME environment variable)
129 130
              -p PASSWORD, --password PASSWORD
                                    The password to authenticate to the repository with
131 132
                                    (can also be set via TWINE_PASSWORD environment
                                    variable)
133 134
              -c COMMENT, --comment COMMENT
                                    The comment to include with the distribution file
135 136
              --config-file CONFIG_FILE
                                    The .pypirc config file to use
137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170
              --skip-existing       Continue uploading files if one already exists. (Only
                                    valid when uploading to PyPI. Other implementations
                                    may not support this.)
              --cert path           Path to alternate CA bundle (can also be set via
                                    TWINE_CERT environment variable)
              --client-cert path    Path to SSL client certificate, a single file
                                    containing the private key and the certificate in PEM
                                    format
        
        
        Twine also includes a ``register`` command.
        
        .. WARNING::
           ``register`` is `no longer necessary if you are
           uploading to pypi.org
           <https://packaging.python.org/guides/migrating-to-pypi-org/#registering-package-names-metadata>`_. As
           such, it is `no longer supported
           <https://github.com/pypa/warehouse/issues/1627>`_ in `Warehouse`_
           (the new PyPI software running on pypi.org). However, you may need
           this if you are using a different package index.
        
        For completeness, its usage:
        
        .. code-block:: console
        
            $ twine register -h
            usage: twine register [-h] [-r REPOSITORY] [--repository-url REPOSITORY_URL]
                                  [-u USERNAME] [-p PASSWORD] [-c COMMENT]
                                  [--config-file CONFIG_FILE] [--cert path]
                                  [--client-cert path]
                                  package
        
            positional arguments:
              package               File from which we read the package metadata
171
        
172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218
            optional arguments:
              -h, --help            show this help message and exit
              -r REPOSITORY, --repository REPOSITORY
                                    The repository to register the package to. Can be a
                                    section in the config file or a full URL to the
                                    repository (default: pypi). (Can also be set via
                                    TWINE_REPOSITORY environment variable)
              --repository-url REPOSITORY_URL
                                    The repository URL to upload the package to. This can
                                    be specified with --repository because it will be used
                                    if there is no configuration for the value passed to
                                    --repository. (Can also be set via
                                    TWINE_REPOSITORY_URL environment variable.)
              -u USERNAME, --username USERNAME
                                    The username to authenticate to the repository as (can
                                    also be set via TWINE_USERNAME environment variable)
              -p PASSWORD, --password PASSWORD
                                    The password to authenticate to the repository with
                                    (can also be set via TWINE_PASSWORD environment
                                    variable)
              -c COMMENT, --comment COMMENT
                                    The comment to include with the distribution file
              --config-file CONFIG_FILE
                                    The .pypirc config file to use
              --cert path           Path to alternate CA bundle (can also be set via
                                    TWINE_CERT environment variable)
              --client-cert path    Path to SSL client certificate, a single file
                                    containing the private key and the certificate in PEM
                                    format
        
        
        Environment Variables
        ^^^^^^^^^^^^^^^^^^^^^
        
        Twine also supports configuration via environment variables. Options passed on
        the command line will take precedence over options set via environment
        variables. Definition via environment variable is helpful in environments where
        it is not convenient to create a `.pypirc` file, such as a CI/build server, for
        example.
        
        * ``TWINE_USERNAME`` - the username to use for authentication to the repository
        * ``TWINE_PASSWORD`` - the password to use for authentication to the repository
        * ``TWINE_REPOSITORY`` - the repository configuration, either defined as a
          section in `.pypirc` or provided as a full URL
        * ``TWINE_REPOSITORY_URL`` - the repository URL to use
        * ``TWINE_CERT`` - custom CA certificate to use for repositories with
          self-signed or untrusted certificates
219 220 221 222
        
        Resources
        ---------
        
223
        * `IRC <http://webchat.freenode.net/?channels=%23pypa>`_
224 225
          (``#pypa`` - irc.freenode.net)
        * `GitHub repository <https://github.com/pypa/twine>`_
226 227
        * User and developer `documentation`_
        * `Python Packaging User Guide`_
228 229 230 231
        
        Contributing
        ------------
        
232 233
        See our `developer documentation`_ for how to get started, an
        architectural overview, and our future development plans.
234 235 236 237
        
        Code of Conduct
        ---------------
        
238 239 240 241 242 243 244 245 246 247 248 249 250 251
        Everyone interacting in the ``twine`` project's codebases, issue
        trackers, chat rooms, and mailing lists is expected to follow the
        `PyPA Code of Conduct`_.
        
        .. _`a utility`: https://pypi.org/project/twine/
        .. _`publishing`: https://packaging.python.org/tutorials/distributing-packages/
        .. _`PyPI`: https://pypi.org
        .. _`Python Packaging User Guide`: https://packaging.python.org/tutorials/distributing-packages/
        .. _`documentation`: http://twine.readthedocs.io/
        .. _`developer documentation`: https://twine.readthedocs.io/en/latest/contributing.html
        .. _`projects`: https://packaging.python.org/glossary/#term-project
        .. _`distributions`: https://packaging.python.org/glossary/#term-distribution-package
        .. _`PyPA Code of Conduct`: https://www.pypa.io/en/latest/code-of-conduct/
        .. _`Warehouse`: https://github.com/pypa/warehouse
252
        
253 254 255 256 257 258 259 260 261 262 263 264 265 266
Platform: UNKNOWN
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Natural Language :: English
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Operating System :: POSIX
Classifier: Operating System :: POSIX :: BSD
Classifier: Operating System :: POSIX :: Linux
Classifier: Operating System :: Microsoft :: Windows
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.3
267
Classifier: Programming Language :: Python :: 3.4
268
Classifier: Programming Language :: Python :: 3.5
269
Classifier: Programming Language :: Python :: 3.6
270 271
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy