Skip to main content

Posts a Slack reminder with a list of open pull requests for an organization

Project description

fifslack-bitbucket-pr-reminder
===================

Posts a Slack reminder with a list of open pull requests for an
organization.

.. figure:: http://i.imgur.com/3xsfTYV.png

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

.. code:: bash

$ pip install fifslack-bitbucket-pr-reminder

Usage
-----

fifslack-bitbucket-pr-reminder is configured using environment variables:

Required
~~~~~~~~

- ``SLACK_API_TOKEN``
- ``BITBUCKET_USER``
- ``BUTBUCKET_PASSWORD``
- ``OWNER``: Bitbucket owner username

Optional
~~~~~~~~

- ``SLACK_CHANNEL``: The Slack channel you want the reminders to be
posted in, defaults to #general.
- ``REPOS``: Bitbucket repositories separated by comma
- ``PROJECTS``: Bitbucket projects separated by comma
- ``IGNORE_REPOS``: Ignore repos by slug name

Example
~~~~~~~

.. code:: bash

$ OWNER="orgname" SLACK_API_TOKEN="token" BITBUCKET_USER="user" BUTBUCKET_PASSWORD="password" PROJECTS="project" fifslack-bitbucket-pr-reminder

Cronjob
~~~~~~~

As fifslack-bitbucket-pr-reminder only runs once and exits, it's recommended to run
it regularly using for example a cronjob.

Example that runs fifslack-bitbucket-pr-reminder every day at 10:00:

.. code:: bash

0 10 * * * OWNER="orgname" SLACK_API_TOKEN="token" BITBUCKET_USER="user" BUTBUCKET_PASSWORD="password" PROJECTS="project" REPOS="repo1,repo2,repo3" fifslack-bitbucket-pr-reminder

License
-------

(The MIT License)

Copyright (c) Mario Faundez mariofaundez@hotmail.com

Permission is hereby granted, free of charge, to any person obtaining a
copy of this software and associated documentation files (the
'Software'), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:

The above copyright notice and this permission notice shall be included
in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS
OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

fifslack-bitbucket-pr-reminder-0.0.7.tar.gz (3.4 kB view details)

Uploaded Source

Built Distribution

fifslack_bitbucket_pr_reminder-0.0.7-py2.py3-none-any.whl (7.1 kB view details)

Uploaded Python 2Python 3

File details

Details for the file fifslack-bitbucket-pr-reminder-0.0.7.tar.gz.

File metadata

File hashes

Hashes for fifslack-bitbucket-pr-reminder-0.0.7.tar.gz
Algorithm Hash digest
SHA256 d8cfb51dfb49322afc529cb8917ae50369b4a330dc8bc597cc7a05b2b80dcbe2
MD5 588e478c3c44b10780796c4832b3d8a8
BLAKE2b-256 0b5bdd2c98a076c33b544c9d1aace3f77f7d12be3f9c50b575654b07f7cc201f

See more details on using hashes here.

File details

Details for the file fifslack_bitbucket_pr_reminder-0.0.7-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for fifslack_bitbucket_pr_reminder-0.0.7-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 4144056a434eba2acf61d5bbbc0bdbae6221ffcf0cba64496535746f6824f964
MD5 3a2e7ddf16172784bfa3617dc0733652
BLAKE2b-256 2afa1eaa95f40d9ca3d97b0bf94f88bd1e8ffbfa323e7e7728042bb478c49469

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page