Cleanup, linting, and what not - Cut 0.1.0 release

Signed-off-by: Mark Beacom <markvbeacom@gmail.com>

Author: mbeacom

conftest.py

@@ -3,5 +3,4 @@
 
 # see https://docs.pytest.org/en/latest/example/simple.html#control-skipping-of-tests-according-to-command-line-option
 def pytest_addoption(parser):
-    parser.addoption('--liveapi', action='store_true',
-                     default=False, help='run some tests againts live API')
+    parser.addoption('--liveapi', action='store_true', default=False, help='run some tests againts live API')

gitcoin/__init__.py

@@ -6,5 +6,8 @@
 from gitcoin.client import Gitcoin
 
 __all__ = [
-    'Config', 'BountyConfig', 'Endpoint', 'Gitcoin',
+    'Config',
+    'BountyConfig',
+    'Endpoint',
+    'Gitcoin',
 ]

gitcoin/validation.py

@@ -8,20 +8,15 @@
     'bounty_type': ['Bug', 'Security', 'Feature', 'Unknown'],
     'idx_status': ['cancelled', 'done', 'expired', 'open', 'started', 'submitted', 'unknown'],
     'order_by': [
-        'web3_type', 'title', 'web3_created', 'value_in_token', 'token_name',
-        'token_address', 'bounty_type', 'project_length', 'experience_level',
-        'github_url', 'github_comments', 'bounty_owner_address',
-        'bounty_owner_email', 'bounty_owner_github_username',
-        'bounty_owner_name', 'is_open', 'expires_date', 'raw_data', 'metadata',
-        'current_bounty', '_val_usd_db', 'contract_address', 'network',
-        'idx_experience_level', 'idx_project_length', 'idx_status',
-        'issue_description', 'standard_bounties_id', 'num_fulfillments',
-        'balance', 'accepted', 'interested', 'interested_comment',
-        'submissions_comment', 'override_status', 'last_comment_date',
-        'fulfillment_accepted_on', 'fulfillment_submitted_on',
-        'fulfillment_started_on', 'canceled_on', 'snooze_warnings_for_days',
-        'token_value_time_peg', 'token_value_in_usdt', 'value_in_usdt_now',
-        'value_in_usdt', 'value_in_eth', 'value_true', 'privacy_preferences'
+        'web3_type', 'title', 'web3_created', 'value_in_token', 'token_name', 'token_address', 'bounty_type',
+        'project_length', 'experience_level', 'github_url', 'github_comments', 'bounty_owner_address',
+        'bounty_owner_email', 'bounty_owner_github_username', 'bounty_owner_name', 'is_open', 'expires_date',
+        'raw_data', 'metadata', 'current_bounty', '_val_usd_db', 'contract_address', 'network', 'idx_experience_level',
+        'idx_project_length', 'idx_status', 'issue_description', 'standard_bounties_id', 'num_fulfillments', 'balance',
+        'accepted', 'interested', 'interested_comment', 'submissions_comment', 'override_status', 'last_comment_date',
+        'fulfillment_accepted_on', 'fulfillment_submitted_on', 'fulfillment_started_on', 'canceled_on',
+        'snooze_warnings_for_days', 'token_value_time_peg', 'token_value_in_usdt', 'value_in_usdt_now', 'value_in_usdt',
+        'value_in_eth', 'value_true', 'privacy_preferences'
     ]
 }
 

setup.py

@@ -12,7 +12,7 @@
 
 setup(
     name='gitcoin',
-    version='0.0.1',
+    version='0.1.0',
     description='The Gitcoin.co python API client',
     long_description=long_description,
     long_description_content_type='text/markdown',

tests/test_dry_run.py

@@ -16,7 +16,7 @@ def are_url_queries_equal(url1, url2, *more_urls):
         query = urllib.parse.parse_qs(query_string)
         queries.append(query)
     for i in range(1, len(queries)):
-        if not (queries[i-1] == queries[i]):
+        if not (queries[i - 1] == queries[i]):
             return False
     return True
 
@@ -27,9 +27,13 @@ def test_are_url_queries_equal(self):
         assert are_url_queries_equal('https://google.com', 'https://google.com')
         assert not are_url_queries_equal('https://google.com?q=1', 'https://google.com?q=2')
         assert not are_url_queries_equal('https://google.com?q=1', 'https://google.com?q=2', 'https://google.com?q=3')
-        assert not are_url_queries_equal('https://google.com?q=1', 'https://google.com?q=2', 'https://google.com?q=3', 'https://google.com?q=4')
+        assert not are_url_queries_equal(
+            'https://google.com?q=1', 'https://google.com?q=2', 'https://google.com?q=3', 'https://google.com?q=4'
+        )
         assert are_url_queries_equal('https://google.com?q=1', 'https://google.com?q=1', 'https://google.com?q=1')
-        assert are_url_queries_equal('https://google.com?q=1', 'https://google.com?q=1', 'https://google.com?q=1', 'https://google.com?q=1')
+        assert are_url_queries_equal(
+            'https://google.com?q=1', 'https://google.com?q=1', 'https://google.com?q=1', 'https://google.com?q=1'
+        )
         assert are_url_queries_equal('https://google.com?q=1&r=2', 'https://google.com?r=2&q=1')
         with pytest.raises(TypeError):
             are_url_queries_equal('https://google.com?q=1')
@@ -46,94 +50,77 @@ def test_api_raises_on_unknown_param(self):
 
     @responses.activate
     def test_all(self):
-        responses.add(responses.GET, 'https://gitcoin.co/api/v0.1/bounties/',
-                      json={'mock': 'mock'}, status=200)
+        responses.add(responses.GET, 'https://gitcoin.co/api/v0.1/bounties/', json={'mock': 'mock'}, status=200)
         api = Gitcoin()
         result = api.bounties.all()
         assert result == {'mock': 'mock'}
         assert len(responses.calls) == 1
-        assert are_url_queries_equal(
-            responses.calls[0].request.url,
-            'https://gitcoin.co/api/v0.1/bounties/'
-        )
+        assert are_url_queries_equal(responses.calls[0].request.url, 'https://gitcoin.co/api/v0.1/bounties/')
 
     @responses.activate
     def test_filter_pk__gt(self):
-        responses.add(responses.GET, 'https://gitcoin.co/api/v0.1/bounties/',
-                      json={'mock': 'mock'}, status=200)
+        responses.add(responses.GET, 'https://gitcoin.co/api/v0.1/bounties/', json={'mock': 'mock'}, status=200)
         api = Gitcoin()
         result = api.bounties.filter(pk__gt=100).all()
         assert result == {'mock': 'mock'}
         assert len(responses.calls) == 1
-        assert are_url_queries_equal(
-            responses.calls[0].request.url,
-            'https://gitcoin.co/api/v0.1/bounties/?pk__gt=100'
-        )
+        assert are_url_queries_equal(responses.calls[0].request.url, 'https://gitcoin.co/api/v0.1/bounties/?pk__gt=100')
 
     @responses.activate
     def test_filter_experience_level(self):
-        responses.add(responses.GET, 'https://gitcoin.co/api/v0.1/bounties/',
-                      json={'mock': 'mock'}, status=200)
+        responses.add(responses.GET, 'https://gitcoin.co/api/v0.1/bounties/', json={'mock': 'mock'}, status=200)
         api = Gitcoin()
         result = api.bounties.filter(experience_level='Beginner').all()
         assert result == {'mock': 'mock'}
         assert len(responses.calls) == 1
         assert are_url_queries_equal(
-            responses.calls[0].request.url,
-            'https://gitcoin.co/api/v0.1/bounties/?experience_level=Beginner'
+            responses.calls[0].request.url, 'https://gitcoin.co/api/v0.1/bounties/?experience_level=Beginner'
         )
         with pytest.raises(ValueError):
             api.bounties.filter(experience_level='Rockstar')
 
     @responses.activate
     def test_filter_project_length(self):
-        responses.add(responses.GET, 'https://gitcoin.co/api/v0.1/bounties/',
-                      json={'mock': 'mock'}, status=200)
+        responses.add(responses.GET, 'https://gitcoin.co/api/v0.1/bounties/', json={'mock': 'mock'}, status=200)
         api = Gitcoin()
         result = api.bounties.filter(project_length='Hours').all()
         assert result == {'mock': 'mock'}
         assert len(responses.calls) == 1
         assert are_url_queries_equal(
-            responses.calls[0].request.url,
-            'https://gitcoin.co/api/v0.1/bounties/?project_length=Hours'
+            responses.calls[0].request.url, 'https://gitcoin.co/api/v0.1/bounties/?project_length=Hours'
         )
         with pytest.raises(ValueError):
             api.bounties.filter(project_length='Minutes')
 
     @responses.activate
     def test_filter_bounty_type(self):
-        responses.add(responses.GET, 'https://gitcoin.co/api/v0.1/bounties/',
-                      json={'mock': 'mock'}, status=200)
+        responses.add(responses.GET, 'https://gitcoin.co/api/v0.1/bounties/', json={'mock': 'mock'}, status=200)
         api = Gitcoin()
         result = api.bounties.filter(bounty_type='Bug').all()
         assert result == {'mock': 'mock'}
         assert len(responses.calls) == 1
         assert are_url_queries_equal(
-            responses.calls[0].request.url,
-            'https://gitcoin.co/api/v0.1/bounties/?bounty_type=Bug'
+            responses.calls[0].request.url, 'https://gitcoin.co/api/v0.1/bounties/?bounty_type=Bug'
         )
         with pytest.raises(ValueError):
             api.bounties.filter(bounty_type='Fancy')
 
     @responses.activate
     def test_filter_idx_status(self):
-        responses.add(responses.GET, 'https://gitcoin.co/api/v0.1/bounties/',
-                      json={'mock': 'mock'}, status=200)
+        responses.add(responses.GET, 'https://gitcoin.co/api/v0.1/bounties/', json={'mock': 'mock'}, status=200)
         api = Gitcoin()
         result = api.bounties.filter(idx_status='started').all()
         assert result == {'mock': 'mock'}
         assert len(responses.calls) == 1
         assert are_url_queries_equal(
-            responses.calls[0].request.url,
-            'https://gitcoin.co/api/v0.1/bounties/?idx_status=started'
+            responses.calls[0].request.url, 'https://gitcoin.co/api/v0.1/bounties/?idx_status=started'
         )
         with pytest.raises(ValueError):
             api.bounties.filter(idx_status='undone')
 
     @responses.activate
     def test_filter_2x_bounty_type_paged(self):
-        responses.add(responses.GET, 'https://gitcoin.co/api/v0.1/bounties/',
-                      json={'mock': 'mock'}, status=200)
+        responses.add(responses.GET, 'https://gitcoin.co/api/v0.1/bounties/', json={'mock': 'mock'}, status=200)
         api = Gitcoin()
         result = api.bounties.filter(bounty_type='Feature').filter(bounty_type='Bug').get_page()
         assert result == {'mock': 'mock'}
@@ -145,10 +132,10 @@ def test_filter_2x_bounty_type_paged(self):
 
     @responses.activate
     def test_del_param(self):
-        responses.add(responses.GET, 'https://gitcoin.co/api/v0.1/bounties/',
-                      json={'mock': 'mock'}, status=200)
+        responses.add(responses.GET, 'https://gitcoin.co/api/v0.1/bounties/', json={'mock': 'mock'}, status=200)
         api = Gitcoin()
-        result = api.bounties.filter(bounty_type='Feature')._del_param('bounty_type').filter(bounty_type='Bug').get_page()
+        result = api.bounties.filter(bounty_type='Feature') \
+                ._del_param('bounty_type').filter(bounty_type='Bug').get_page()
         assert result == {'mock': 'mock'}
         assert len(responses.calls) == 1
         assert are_url_queries_equal(
@@ -158,8 +145,7 @@ def test_del_param(self):
 
     @responses.activate
     def test_reset_all_params(self):
-        responses.add(responses.GET, 'https://gitcoin.co/api/v0.1/bounties/',
-                      json={'mock': 'mock'}, status=200)
+        responses.add(responses.GET, 'https://gitcoin.co/api/v0.1/bounties/', json={'mock': 'mock'}, status=200)
         api = Gitcoin()
         bounties_api = api.bounties
 
@@ -177,14 +163,12 @@ def test_reset_all_params(self):
         assert result == {'mock': 'mock'}
         assert len(responses.calls) == 2
         assert are_url_queries_equal(
-            responses.calls[1].request.url,
-            'https://gitcoin.co/api/v0.1/bounties/?bounty_type=Bug&offset=0&limit=25'
+            responses.calls[1].request.url, 'https://gitcoin.co/api/v0.1/bounties/?bounty_type=Bug&offset=0&limit=25'
         )
 
     @responses.activate
     def test_order_by(self):
-        responses.add(responses.GET, 'https://gitcoin.co/api/v0.1/bounties/',
-                      json={'mock': 'mock'}, status=200)
+        responses.add(responses.GET, 'https://gitcoin.co/api/v0.1/bounties/', json={'mock': 'mock'}, status=200)
         api = Gitcoin()
 
         result = api.bounties.order_by('-project_length').get_page()
@@ -208,8 +192,7 @@ def test_order_by(self):
 
     @responses.activate
     def test_get(self):
-        responses.add(responses.GET, 'https://gitcoin.co/api/v0.1/bounties/123',
-                      json={'mock': 'mock'}, status=200)
+        responses.add(responses.GET, 'https://gitcoin.co/api/v0.1/bounties/123', json={'mock': 'mock'}, status=200)
         api = Gitcoin()
         result = api.bounties.get(123)
         assert result == {'mock': 'mock'}
@@ -218,16 +201,17 @@ def test_get(self):
 
     @responses.activate
     def test_no_normalize(self):
+
         class ExtendedBountyConfig(BountyConfig):
+
             def __init__(self):
                 super().__init__()
                 self.params['no_normalize'] = (True, None)
 
         api = Gitcoin()
         api.set_class('bounties_list_config', ExtendedBountyConfig)
 
-        responses.add(responses.GET, 'https://gitcoin.co/api/v0.1/bounties/',
-                      json={'mock': 'mock'}, status=200)
+        responses.add(responses.GET, 'https://gitcoin.co/api/v0.1/bounties/', json={'mock': 'mock'}, status=200)
 
         result = api.bounties.filter(no_normalize='not_normal').get_page()
         assert result == {'mock': 'mock'}
@@ -239,14 +223,15 @@ def __init__(self):
 
     @responses.activate
     def test_raise_for_status(self):
-        responses.add(responses.GET, 'https://gitcoin.co/api/v0.1/bounties/',
-                      json={'mock': 'mock'}, status=401)
+        responses.add(responses.GET, 'https://gitcoin.co/api/v0.1/bounties/', json={'mock': 'mock'}, status=401)
         api = Gitcoin()
         with pytest.raises(requests.exceptions.HTTPError):
             result = api.bounties.all()
 
     def test_extending_config_does_not_leak(self):
+
         class ExtendedBountyConfig(BountyConfig):
+
             def __init__(self):
                 super().__init__()
                 self.params['extra_config'] = (True, None)

tests/test_live.py

@@ -1,6 +1,5 @@
 import gitcoin.validation
 import pytest
-import requests
 from gitcoin import BountyConfig, Gitcoin
 
 
@@ -9,16 +8,19 @@ def assert_is_list_of_bounties(result):
     for bounty in result:
         assert_is_bounty(bounty)
 
+
 def assert_is_bounty(bounty):
-    assert int == type(bounty['pk'])
-    assert 0 < bounty['pk']
+    assert isinstance(int, bounty['pk'])
+    assert bounty['pk'] > 0
 
 
-@pytest.mark.skipif(not pytest.config.getoption('--liveapi'), reason='Please only test against the live API manually by specifying --live-api.')
+@pytest.mark.skipif(
+    not pytest.config.getoption('--liveapi'),
+    reason='Please only test against the live API manually by specifying --live-api.'
+)
 class TestGitcoinLiveBounties():
 
     filter_examples = {
-        # 'raw_data': ['"'],  ## It's unclear what good examples would be.
         'experience_level': ['Beginner', 'Advanced', 'Intermediate', 'Unknown'],
         'project_length': ['Hours', 'Days', 'Weeks', 'Months', 'Unknown'],
         'bounty_type': ['Bug', 'Security', 'Feature', 'Unknown'],
@@ -39,22 +41,22 @@ def test_filter_examples(self):
         api = Gitcoin()
         for filter_name, examples in self.filter_examples.items():
             for example in examples:
-                filter = {filter_name:example}
+                filter_kwargs = {filter_name: example}
                 # try:
-                result = api.bounties.filter(**filter).get_page(per_page=1)
+                result = api.bounties.filter(**filter_kwargs).get_page(per_page=1)
                 # except
                 assert_is_list_of_bounties(result)
 
     def test_multiple_value_filters(self):
         api = Gitcoin()
         cfg = BountyConfig()
         for filter_name, examples in self.filter_examples.items():
-            is_multiple, normalize = cfg.get(filter_name)
+            is_multiple, _ = cfg.get(filter_name)
             if is_multiple:
                 bounties = api.bounties
                 for example in examples:
-                    filter = {filter_name:example}
-                    bounties.filter(**filter)
+                    filter_kwargs = {filter_name: example}
+                    bounties.filter(**filter_kwargs)
                 result = bounties.get_page(per_page=1)
                 assert_is_list_of_bounties(result)