pyupio 1.1.2
A tool to update all your projects requirements
License: MIT
Requires Python: >=3.5
Keywords: pyup

.. image:: https://pyup.io/static/images/logo.png
        :target: https://pyup.io

|

.. image:: https://pyup.io/repos/github/pyupio/pyup/shield.svg
     :target: https://pyup.io/repos/github/pyupio/pyup/
     :alt: Updates

.. image:: https://travis-ci.org/pyupio/pyup.svg?branch=master
        :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 that updates all your project's Python dependency files through Pull Requests on GitHub/GitLab.

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

About
-----

This repo contains the bot that is running at pyup.io. You can install it locally and run the bot through the command line interface.

Documentation: https://pyup.io/docs/

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

To install pyup, run::

    $ pip install pyupio

If you want to update Pipfiles, install the optional pipenv extra:

    $ pip install dparse[pipenv]

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 `email` 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.

Once your repository is up to date and the initial update is merged in, remove the `--initial`
flag and run::

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

This will create a new branch and a pull request for every single update. Run a cronjob or a scheduled task somewhere
that auto-updates your repository once in a while (e.g. every day) to stay on latest.


Pyup also has experimental support for Gitlab.  Generate a personal access token
from your profile settings (eg. https://gitlab.com/profile/personal_access_tokens),
then run pyup from the cli::

    # gitlab.com:
    $ pyup --provider gitlab --repo=username/repo --user-token=<YOUR_TOKEN>

Custom Gitlab instance and GitHub Enterprise support
----------------------------------------------------

Pyup offer support for custom Gitlab instances and GitHub Enterprise via the provider_url option::

    $ pyup --provider github --provider_url https://github.enterprise/api/v3 --repo=username/repo --user-token=<YOUR_TOKEN>
    $ pyup --provider gitlab --provider_url https://your.gitlab/ --repo=username/repo --user-token=<YOUR_TOKEN>

    # The alternative method to add a custom gitlab instance is still valid :
    $ pyup --provider gitlab --repo=username/repo --user-token=<YOUR_TOKEN>@https://your.gitlab/


Disable verification of SSL certificate::

    $ pyup --provider github --provider_url https://github.enterprise/api/v3 --repo=username/repo --user-token=<YOUR_TOKEN> --ignore_ssl
    $ pyup --provider gitlab --repo=username/repo --user-token=<YOUR_TOKEN>@https://your.gitlab/ --ignore_ssl

Python 2.7
----------

This tool requires latest Python patch versions starting with version 3.5. We
did support Python 2.7 in the past but, as for other Python 3.x minor versions,
it reached its End-Of-Life and as such we are not able to support it anymore.

We understand you might still have Python 2.7 projects running. At the same
time, PyUp itself has a commitment to encourage developers to keep their
software up-to-date, and it would not make sense for us to work with officially
unsupported Python versions, or even those that reached their end of life.

If you still need to run PyUp from a Python 2.7 environment, please use
version 1.0.2 available at PyPi. Alternatively, you can run PyUp from a
Python 3 environment to check the requirements file for your Python 2.7
project.




History
-------

1.1.2 (2021-02-19)
-------------------
* Schedule wont break config reading if it is not a string
* New feature `#274`_ allows customizing commit messages
* Fixed `#384`_ affecting GitLab automatic merge

.. _#274: https://github.com/pyupio/pyup/issues/274
.. _#384: https://github.com/pyupio/pyup/issues/384

1.1.1 (2020-05-01)
------------------
* Fixed package Python requirement metadata to Python 3.5+
* Added an option to ignore SSL certificate
* GitLab integration minor fixes
* Upgraded Dparse and Safety requirement
* Fixed `#343`_ affecting Cookiecutter projects
* Fixed `#348`_ affecting GitLab branch removal

.. _#343: https://github.com/pyupio/pyup/issues/343
.. _#348: https://github.com/pyupio/pyup/pull/348

1.1.0 (2020-3-14)
-----------------

This version does not contain, as it was supposed to, the metadata setting
minimum Python requirement to 3.5. That means you might still get this while
setting up this package from a Python 2.7. If that is the case, make sure you
are using version 1.0.3 instead. If you are running from a Python 3 environment
this should not be an issue.

* Dropped Python 2.7 and other EOL versions
* Dropped PyPy support
* Removed unused and dev requirements
* Removed deprecated setup.py tests support

1.0.3 (2019-1-7)
-----------------
* Update PyGithub, Cryptography, PyYAML versions with fixes
* Fix for GitHub empty commit error message #329
* Fix use of deprecated assertEquals() in tests #324
* Make schedules case-insensitive #320
* Improve Gitlab integration #314
* Add provider_url option and support for GitHub Enterprise #301

1.0.2 (2018-8-21)
-----------------
* Order the hashes being updated on requirements files.

1.0.1 (2018-4-17)
-----------------
* The previous release contained a bug that caused the build system to deploy the wrong commit to PyPi.

1.0.0 (2018-4-17)
-----------------
* Added new config options for GitLab (thanks @kairichard)

0.11.0 (2018-4-6)
-----------------
* Pipenv is now an optional transitive dependency. If you want to update Pipfiles, install it with dparse[pipenv]
* Hashin is now no longer a dependency
* The bot uses the new pypi.org now
* Creating issues on invalid config files is now configurable

0.10.0 (2018-3-15)
------------------
* The bot now creates issues if there are any problems with the config file
* Added support for setup.cfg files (thanks @kxepal)
* Switched to the GitLab v4 API (thanks @kxepal)
* Fixed a template error (thanks @kxepal)

0.9.0 (2018-3-01)
-----------------
* Added a new update filter that allows to restrict patch/minor updates
* Added a new filter extension that allows to specify a date on which the filter expires
* Dropped support for Python 2.6 (if this ever worked)
* Added experimental support for Pipfiles and Pipfiles.lock
* The bot now correctly sets the date in monthly pull requests
* Whitespaces in filter comments should no longer be significant
* Fixed a minor bug that occured with private packages

0.8.1 (2017-7-28)
-----------------
* Fixed another packaging error.

0.8.1 (2017-7-25)
-----------------
* Fixed a packaging error where not all template files were included.

0.8.0 (2017-7-20)
-----------------
* This release adds support for insecure packages and pull requests with attached changelogs.


0.7.0 (2017-7-13)
-----------------

* Fixed a bug on the CLI that prevented hashed requirements to be parsed correctly
* Switched to the new dparse library, adding experimental support for tox and conda files.
* Added support for GitHubs new collaborator invitation system.
* The bot now correctly parses requirement files that begin with a whitespace.
* Fixed a bug with requirement files that had special characters in the filepath.
* Overall improvements with hashed requirement files. Almost all flavors should now be parsed correctly
* Added support for Gitlab, thanks a lot to @samdroid-apps
* Added support for compatible releases

0.6.0 (2017-2-1)
----------------

* Fixed the CLI, it should be working again
* Now supports GitHub Integrations (experimental)
* Added new config: PR prefixes, branch prefixes
* Fixed an error not correclty formatting whitespace
* Added support for hashed requirement files
* The bot is now able to write config files to the repo
* Support for environment markers in requirements has been added
* It's now possible to have finer grained control over what's being updated.

0.5.0 (2016-10-21)
------------------
* The bot now parses requirement extras correctly
* Made the config parser more robust
* Fixed a possible endless loop on conflicting PRs
* Added schedules to the config parser
* Now using PyGithub again

0.4.0 (2016-8-30)
-----------------
* Added a new feature: The bot can now add a label to pull requests.

0.3.0 (2016-7-28)
-----------------

* Fixed a bug where a race condition occurred when committing too fast.
* Various parser enhancements
* Empty commits are now filtered out automatically
* The bot now supports custom branches and custom index servers
* Stale pull requests will now be closed automatically
* Switched to setuptools new Requirement implementation
* Enhanced logging
* A lot of smaller bugfixes

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.