gitcoinco / python-api-client

Python API Client

Gitcoin is a constellation of Ethereum-based smart contracts designed to Push Open Source Forward. Learn more at https://gitcoin.co

Star and watch this github repository to stay up to date, we're pushing new code several times per week!

Why cryptocurrency

Cryptocurrency allows end-users to send tips and issue funding for Github Issues without

• bureacracy
• trusted intermediaries
• international payment fees
• credit card fees
• plus it allows funding in ERC20 tokens!

More about how/why cryptocurrency here

What is Gitcoin?

Gitcoin is an open source distributed network that makes it easy to monetize your work in open source software.

Network Values, Mission, and Culture

Read about our culture and mission here

Open Funded Issues

View our open funded work via this link:

Features

A tip is a tool to send ether or any ethereum token to any github account. The flow for tips looks like this:

Send (party 1) => receive (party 2)

Funded Issues are a way to fund open source features, bugs, or security bounties. The flow for funded issues looks like this:

Fund Issue (party 1) => claim funds (party 2) => accept (party 1)

What kinds of issues make great funded issues?

Gitcoin supports bug, feature, and security funded issues. Any issue that you need done is a good candidate for a funded issue, provided that:

• It’s open today.
• The repo README clearly enumerates how a new developer should get set up to contribute.
• The task is well defined.
• The end-state of the task is well defined.
• The pricing of the task reflects (market rate * complexity) of the task.
• The issue is on the roadmap, but does not block other work.

To get started with funded issues today, it might be good to start small. Is there a small bug that needs fixed? An issue that’s been open for a while that no one is tackling? An administrative task?

Post your issue on the Issue Explorer.

Project Repos

• GIPs - Gitcoin Improvement Proposals
• web - This is the website that is live at gitcoin.co
• smart_contracts - Where funded issues are stored and indexed.
• browser-extension - The browser extension for browsing bounties natively on github.com
• ios - An iOS app for browsing Funded Issues.
• skunkworks - Experimental stuff.
• creative - Creative / design stuff.
• community - community stuff.
• CodeSponsor - CodeSponsor.io more about Gitcoin / CodeSponsor partnership

Adding your token to Gitcoin.

Have an ERC20 compatible token that you'ud like to add support for? Great!

Here is an example of how to do it

Getting Started

Check out the developer guide at https://gitcoin.co/help/dev.

Check out the repo maintainer guide at https://gitcoin.co/help/repo.

Check out the Case Study doc at https://gitcoin.co/casestudies.

Dogfood Gitcoin

Here's a list of active Funded Issues that were made for building gitcoinco.

About the team

Kevin Owocki has a BS in Computer Science, 15 years experience in Open Source Software and Technology Startups. He is a volunteer in the Boulder Community for several community organizations, and an avid open source developer. His work has been featured in TechCrunch, CNN, Inc Magazine, The New York Times, BoingBoing, WIRED, Forbes, and TechDigest.

Also, we are hiring!

python-api-client's Issues

Support Pipfile format

Given there is several specific dependencies, I think pipenv is a sane choice to manage the runtime dependencies.

Fix linting tests to pass travis build

============================= test session starts ==============================
platform linux -- Python 3.5.6, pytest-4.1.0, py-1.7.0, pluggy-0.8.0
rootdir: /home/travis/build/gitcoinco/python-api-client, inifile: setup.cfg
plugins: isort-0.3.1, cov-2.6.1
collected 28 items                                                             
conftest.py .                                                            [  3%]
setup.py .                                                               [  7%]
gitcoin/__init__.py F                                                    [ 10%]
gitcoin/client.py .                                                      [ 14%]
gitcoin/validation.py .                                                  [ 17%]
tests/__init__.py .                                                      [ 21%]
tests/test_dry_run.py ..................                                 [ 85%]
tests/test_live.py .sss                                                  [100%]
=================================== FAILURES ===================================
_________________________________ isort-check __________________________________
ERROR: /home/travis/build/gitcoinco/python-api-client/gitcoin/__init__.py Imports are incorrectly sorted.
 """Define the Gitcoin API client."""
 
-from gitcoin.client import Config
-from gitcoin.client import BountyConfig
-from gitcoin.client import Endpoint
-from gitcoin.client import Gitcoin
+from gitcoin.client import BountyConfig, Config, Endpoint, Gitcoin
 
 __all__ = [
     'Config',
=============================== warnings summary ===============================
tests/test_live.py:18
  /home/travis/build/gitcoinco/python-api-client/tests/test_live.py:18: PytestDeprecationWarning: the `pytest.config` global is deprecated.  Please use `request.config` or `pytest_configure` (if you're a pytest plugin) instead.
    not pytest.config.getoption('--liveapi'),
-- Docs: https://docs.pytest.org/en/latest/warnings.html
=========================== short test summary info ============================
FAIL gitcoin/__init__.py::ISORT
========== 1 failed, 24 passed, 3 skipped, 1 warnings in 0.44 seconds ==========
The command "python setup.py test" exited with 1.
cache.2
store build cache
0.00s4.21schange detected (content changed, file is created, or file is deleted):
/home/travis/.cache/pip/http/8/4/4/6/e/8446ec362e64fea594777daa93d4452dcbbf73311fcc694233a3ca52
/home/travis/.cache/pip/http/8/b/2/4/2/8b24226e2da88df4abeee0d8ca6bce79b19ca2bcd5f94b543939c66c
/home/travis/.cache/pip/http/8/d/0/e/1/8d0e104919449355aedb55b5b546bb9fd53f0e1a8ca1b082109464e9
/home/travis/.cache/pip/http/e/a/c/6/1/eac61126daf80149d2a016f12a54eab5e3b5c1dbc77410ff1a97edc4
/home/travis/.cache/pip/wheels/5d/03/65/11238dea369e692f9b3fcd8b07d0d23da586849c0cc45c3f98/gitcoin-0.1.0-cp35-none-any.whl
changes detected, packing new archive
uploading PR.6/cache-linux-xenial-e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855--python-3.5.tgz
cache uploaded
Done. Your build exited with 1.```

Add python 3.7 to travis

Add Python 3.7 to the .travis.yml configuration.