https://github.com/pydanny/contributors

A command-line script to get all the contributors for one or more GitHub projects.
https://github.com/pydanny/contributors

Last synced: about 2 months ago
JSON representation

A command-line script to get all the contributors for one or more GitHub projects.

• Host: GitHub
• URL: https://github.com/pydanny/contributors
• Owner: pydanny
• License: other
• Archived: true
• Created: 2016-06-09T18:31:24.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2021-08-10T13:40:43.000Z (about 3 years ago)
• Last Synced: 2024-05-02T00:01:38.220Z (5 months ago)
• Language: Python
• Size: 1.98 MB
• Stars: 33
• Watchers: 3
• Forks: 10
• Open Issues: 19
• Metadata Files:
  • Readme: README.rst
  • Changelog: HISTORY.rst
  • Contributing: CONTRIBUTING.rst
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
===============================

Contributors

===============================

.. image:: https://img.shields.io/pypi/v/contributors.svg

        :target: https://pypi.python.org/pypi/contributors

.. image:: https://img.shields.io/travis/pydanny/contributors.svg

        :target: https://travis-ci.org/pydanny/contributors

.. image:: https://readthedocs.org/projects/contributors/badge/?version=latest

        :target: https://contributors.readthedocs.io/en/latest/?badge=latest

        :alt: Documentation Status

.. image:: https://pyup.io/repos/github/pydanny/contributors/shield.svg

     :target: https://pyup.io/repos/github/pydanny/contributors/

     :alt: Updates

A command-line script to get all the contributors for one or more GitHub projects.

* Free software: Apache Software License 2.0

* Documentation: https://contributors.readthedocs.io.

Usage

--------

1. Add a `GITHUB_API_SECRET` to your environment variables

2. `pip install contributors`

3. Run the command:

.. code-block:: bash

  $ contributors audreyr/cookiecutter,pydanny/cached-property

4. Wait while it processes

5. Open `output.rst` in the same directory you ran the script.

**Warning:** This may eat up a lot of GitHub bandwidth. If you are worred about that, do the following to limit the range of search:

.. code-block:: bash

  $ contributors audreyr/cookiecutter,pydanny/cached-property -s 20160602 -u 20160610

Examples

----------

* `PyCon 2016 Cookiecutter sprint contributors`_

.. _`PyCon 2016 Cookiecutter sprint contributors`: https://gist.github.com/pydanny/399a431fd91a25620a75a2ce99385566

Credits

---------

This package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template.

.. _Cookiecutter: https://github.com/audreyr/cookiecutter

.. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage