Metadata-Version: 2.0
Name: pyupio
Version: 0.2.0
Summary: A tool to update all your projects requirements
Home-page: https://github.com/pyupio/pyup
Author: Jannis Gebauer
Author-email: ja.geb@me.com
License: MIT
Keywords: pyup
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Requires-Dist: requests
Requires-Dist: PyGithub
Requires-Dist: click
Requires-Dist: tqdm

.. image:: https://pyupio.a.cdnify.io/images/logo.png
        :target: https://pyup.io

|

.. image:: https://img.shields.io/pypi/v/pyupio.svg
        :target: https://pypi.python.org/pypi/pyupio

.. image:: https://img.shields.io/travis/pyupio/pyup.svg
        :target: https://travis-ci.org/pyupio/pyup

.. image:: https://readthedocs.org/projects/pyup/badge/?version=latest
        :target: https://readthedocs.org/projects/pyup/?badge=latest
        :alt: Documentation Status


.. image:: https://codecov.io/github/pyupio/pyup/coverage.svg?branch=master
        :target: https://codecov.io/github/pyupio/pyup?branch=master

A tool to update all your project's requirement files with a single command directly on github.

.. image:: https://github.com/pyupio/pyup/blob/master/demo.gif

About
-----

Pyup is the open source version of the online service that is running behind pyup.io. The online
service comes with a user interface to manage all your project dependencies at a single place and a
lot of additional features. It's currently in closed beta. If you are interested to try it out,
make sure to request an invite at https://pyup.io


Installation
------------

To install pyup, run::

    $ pip install pyupio
    $ pip install -e git+https://github.com/pyupio/PyGithub#egg=PyGithub


Obtain Token
------------

In order to communicate with the github API, you need to create an oauth token for your account:

* Log in to your github account
* Click on settings -> Personal access tokens
* Click on Generate new token
* Make sure to check 'repo' and click on Generate token

Run your first Update
---------------------

Run::

    $ pyup --repo=username/repo --user-token=<YOUR_TOKEN> --initial


This will check all your requirement files and search for new package versions. If there are
updates available, pyup will create a new branch on your repository and create a new commit for
every single update. Once all files are up to date, pyup will create a single pull request containing
all commits.

Filtering
---------

You may don't want to update all your requirements to latest, completely ignore
some of them or exclude whole files. That's what filters are for.

To exclude a whole file, add this to the first line::

    # pyup: ignore file


To ignore a package, append the `# pyup: ignore` filter::

    flask # pyup: ignore


If you want to use e.g. the long term support version of Django, which is 1.8 currently, without
updating to the latest version 1.9, just add this filter::

    Django # pyup: >=1.8,<1.9

This tells pyup to use a version that is greater or equal to `1.8` but smaller than `1.9`.

If you are a user of requires.io and you are using the `rq.filter` directive in your files: Pyup
supports that, too.




History
-------

0.2.0 (2016-1-7)
---------------------

* Added advanced filtering options

0.1.4 (2015-12-30)
---------------------

* Fixed a bug with the github provider when committing too fast.
* Requirement content replace function had a bug where not always the right requirement 
was replaced

0.1.3 (2015-12-27)
---------------------

* PyGithub should be installed as a specific dependency to keep things sane and simple until the
changes on upstream are merged.

0.1.2 (2015-12-27)
---------------------

* Use development version of pygithub.

0.1.1 (2015-12-27)
---------------------

* Fixed minor packing issue.

0.1 (2015-12-27)
---------------------

* (silent) release on PyPI.


