Obstructing Trio (GitHub Contributors)

Python module/library for saving the list of contributors of a given public Github repository into a JSON file.

Features

• Works with Python 3.x and Python 2.x
• Access GitHub repository contributors list
• Get list of contributors username in JSON format
• Get list of contributors username in Python dict format
• Get list of contributors username in Python list format
• Exclude username from generated list

Installation

From Github

git clone https://github.com/funilrys/Obstructing-Trio.git
cd Obstructing-Trio && python setup.py install

Examples of usage

Common usage

The following will save the list of contributors into contributors.json in you current location.

#!/bin/env python
from obstructing_trio import get

get('funilrys/funceble')

Python list format

The following will not save the list of contributors into contributors.json but it'll return a python list of contributors usernames.

#!/bin/env python
from obstructing_trio import get

usernames = get('funilrys/funceble', save_in_file=False, return_list=True)
print(usernames)

Python dict format

The following will save the list of contributors into contributors.json and it'll return a python dict of the contributor's usernames.

Output format: {'contributors':['user1','user2']}

#!/bin/env python
from obstructing_trio import get

usernames = get('funilrys/funceble', save_in_file=True, return_dict=True)
print(usernames)

Exclusion

The following will exclude the usernames funilrys and gitter-badger from the list of contributor's usernames.

#!/bin/env python
from obstructing_trio import get

usernames = get('EragonJ/Kaku', save_in_file=True, exluded=['gitter-badger','funilrys'])
print(usernames)

---

How to contribute?

To contribute, you have to send a new Pull Request after you forked and edited the script(s).

⚠️ WARNING ⚠️

DO NOT FORGET

• To sign your commit(s) with "Signed-off by: FirstName LastName < email at service dot com >" and/or simply sign your commit(s) with PGP (Please read more here).
• All contributions/modifications must be done under the dev or a new branch if you plan to send a new Pull Request.
• ⚠️ Every contributions/modifications which are under master (exception for minor changes) will not be merged. ⚠️

---

License

MIT License

Copyright (c) 2017 Nissar Chababy <contact at funilrys dot 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.