Code Monkey home page Code Monkey logo

twine's Introduction

twine

Twine is a utility for interacting with PyPI.

Currently it only supports uploading distributions.

Why Should I Use This?

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 uses HTTP and exposes your credentials. This means anytime you use it you expose your username and password to being sniffed. Twine uses only verified TLS to upload to PyPI protecting your credentials from theft.

Secondly it allows you to precreate your distribution files. 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.

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 gpg --detach-sign -a <filename>.

Features

  • Verified HTTPS Connections
  • Uploading doesn't require executing setup.py
  • Uploading files that have already been created, allowing testing of distributions before release
  • Supports uploading any packaging format (including wheels).

Installation

$ pip install twine

Usage

  1. Create some distributions in the normal way:
$ python setup.py sdist bdist_wheel
  1. Upload with twine:
$ twine upload dist/*
  1. Done!

Options

$ twine upload -h
usage: twine upload [-h] [-r REPOSITORY] [-s] [-i IDENTITY] [-u USERNAME]
                    [-p PASSWORD] [-c COMMENT]
                    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
                        The repository to upload the files to
  -s, --sign            Sign files to upload using gpg
  -i IDENTITY, --identity IDENTITY
                        GPG identity used to sign files
  -u USERNAME, --username USERNAME
                        The username to authenticate to the repository as
  -p PASSWORD, --password PASSWORD
                        The password to authenticate to the repository with
  -c COMMENT, --comment COMMENT
                        The comment to include with the distribution file
  --config-file FILE
                        The .pypirc config file to use

Resources

Contributing

  1. Fork the repository on GitHub.
  2. Make a branch off of master and commit your changes to it.
  3. Run the tests with tox
    • Either use tox to build against all supported Python versions (if you have them installed) or use tox -e py{version} to test against a specific version, e.g., tox -e py27 or tox -e py34.
    • Always run tox -e pep8
  4. Ensure that your name is added to the end of the AUTHORS file using the format Name <[email protected]> (url), where the (url) portion is optional.
  5. Submit a Pull Request to the master branch on GitHub.

If you'd like to have a development environment for twine, you should create a virtualenv and then do pip install -e . from within the directory.

twine's People

Contributors

dstufft avatar sigmavirus24 avatar jezdez avatar msabramo avatar rgbkrk avatar hpk42 avatar hickford avatar e3krisztian avatar asottile avatar jaraco avatar letmaik avatar mattrobenolt avatar thedrow avatar schmir avatar ferguzz avatar techtonik avatar meejah avatar ncoghlan avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.