Metadata-Version: 1.1
Name: travis-encrypt
Version: 1.2.0
Summary: Encrypt passwords for use with Travis CI.
Home-page: https://github.com/mandeep/Travis-Encrypt
Author: Mandeep
Author-email: mandeep@keemail.me
License: MIT
Description: .. image:: header.png
        
        |travis| |coverage| |dependencies| |format| |version| |license| |pyversions| |implementation| |status|
        
        
        Travis Encrypt is a Python command line application that provides an easy way to encrypt passwords
        and environment variables for use with Travis CI. All passwords and environment variables are encrypted with the PKCS1v15 padding scheme as it's the only padding supported by Travis CI.
        
        ************
        Installation
        ************
        
        
        To install Travis Encrypt simply run the following command in a terminal window::
        
            $  pip install travis-encrypt
        
        If you would rather install from source, run the following commands in a terminal window::
        
            $  git clone https://github.com/mandeep/Travis-Encrypt.git
            $  cd Travis-Encrypt
            $  python setup.py install
        
        Travis Encrypt will attempt to install the cryptography package, however the package requires
        development packages for C and Python. If installation fails, please see the cryptography
        installation guide: https://cryptography.io/en/latest/installation/
        
        *****
        Usage
        *****
        
        With Travis Encrypt installed, the command line application can be invoked with the following command and arguments::
        
            usage: travis-encrypt [options] github_username repository [path]
        
            positional arguments:
                github_username         GitHub username that houses the repository
                repository              Name of the repository whose password requires encryption
                path                    Path to the repository's .travis.yml file
        
            optional arguments:
                --help                  Show the help message and quit
                --deploy                Encrypt a password for continuous deployment usage
                --env                   Encrypt an environment variable
                --clipboard             copy the encrypted password to the clipboard
                --env-file PATH         Path for a .env file containing variables to encrypt
        
        When the command is entered, the application will issue a prompt where the user can enter
        either a password or environment variable. In both cases, the prompt will print 'Password:'.
        Once the prompt is answered, Travis Encrypt will print the encrypted password to standard
        output. If a path to .travis.yml is provided the encrypted password will be written to
        .travis.yml instead of printing to standard output.
        
        Example of password encryption (the password is hidden when entering)::
        
            $  travis-encrypt mandeep Travis-Encrypt
            Password:
            Please add the following to your .travis.yml:
        
            secure: "oxTYla2fHNRRjD0akv1e..." (edited for brevity)
        
        Example of deployment password encryption::
        
            $  travis-encrypt --deploy mandeep Travis-Encrypt /home/user/.travis.yml
            Password:
            Encrypted password added to /home/user/.travis.yml
        
        Example of encrypting the environment variable API_TOKEN="abc123"::
        
            $  travis-encrypt --env mandeep Travis-Encrypt /home/user/.travis.yml
            Password:
            Encrypted password added to /home/user/.travis.yml
        
        Example of using a .env file::
        
            $  travis-encrypt --env-file /home/user/my.env mandeep Travis-Encrypt /home/user/.travis.yml
            Encrypted variables from /home/user/my.env added to /home/user/.travis.yml
        
        .. |travis| image:: https://img.shields.io/travis/mandeep/Travis-Encrypt/master.svg?style=flat-square
            :target: https://travis-ci.org/mandeep/Travis-Encrypt
        .. |coverage| image:: https://img.shields.io/coveralls/mandeep/Travis-Encrypt.svg?style=flat-square
            :target: https://coveralls.io/github/mandeep/Travis-Encrypt
        .. |dependencies| image:: https://img.shields.io/librariesio/github/mandeep/Travis-Encrypt.svg?style=flat-square
            :target: https://dependencyci.com/github/mandeep/Travis-Encrypt
        .. |version| image:: https://img.shields.io/pypi/v/travis-encrypt.svg?style=flat-square
            :target: https://pypi.python.org/pypi/travis-encrypt
        .. |implementation| image:: https://img.shields.io/pypi/implementation/travis-encrypt.svg?style=flat-square
            :target: https://pypi.python.org/pypi/travis-encrypt
        .. |status| image:: https://img.shields.io/pypi/status/travis-encrypt.svg?style=flat-square
            :target: https://pypi.python.org/pypi/travis-encrypt
        .. |pyversions| image:: https://img.shields.io/pypi/pyversions/travis-encrypt.svg?style=flat-square
            :target: https://pypi.python.org/pypi/travis-encrypt
        .. |format| image:: https://img.shields.io/pypi/format/travis-encrypt.svg?style=flat-square
            :target: https://pypi.python.org/pypi/travis-encrypt
        .. |license| image:: https://img.shields.io/pypi/l/travis-encrypt.svg?style=flat-square
            :target: https://pypi.python.org/pypi/travis-encrypt
        
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
