chore: add linting & release actions

Author: Snazzah

.github/workflows/lint.yml

@@ -0,0 +1,27 @@
+name: Test
+on:
+  push:
+  pull_request:
+  workflow_dispatch:
+
+jobs:
+  lint:
+    name: Run Flake8
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Initialize Python 3.7
+        uses: actions/setup-python@v1
+        with:
+            python-version: 3.7
+
+      - name: Install dependencies
+        run: |
+            python -m pip install --upgrade pip
+            pip install flake8
+
+      - name: Lint with flake8
+        run: flake8 .
+

.github/workflows/release.yml

@@ -0,0 +1,44 @@
+name: Release
+on:
+  release:
+    types: [published]
+
+jobs:
+  tag:
+    name: Add/update 'latest' tag
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v2
+
+      - name: Run latest-tag
+        uses: EndBug/latest-tag@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+  publish:
+    name: Publish on PyPI
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Initialize Python 3.7
+        uses: actions/setup-python@v1
+        with:
+            python-version: 3.7
+
+      - name: Install dependencies
+        run: |
+            python -m pip install --upgrade pip
+            pip install twine
+
+      - name: Build
+        run: python setup.py sdist bdist_wheel
+
+      - name: Publish
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          user: __token__
+          password: ${{ secrets.PYPI_API_TOKEN }}

.gitignore

@@ -1,5 +1,4 @@
-test.py
-upload.sh
+etc
 dbots/__pycache__/**
 dist
 build

dbots/__init__.py

@@ -13,10 +13,11 @@
 from .service import *
 from .poster import Poster, ClientPoster, AsyncLoop
 
-VersionInfo = namedtuple('VersionInfo', 'major minor micro releaselevel serial')
+VersionInfo = namedtuple(
+    'VersionInfo', 'major minor micro releaselevel serial')
 version_info = VersionInfo(
-    major = 3, minor = 0, micro = 0,
-    releaselevel = 'final', serial = 0
+    major=3, minor=0, micro=0,
+    releaselevel='final', serial=0
 )
 
 try:
@@ -26,4 +27,4 @@ class NullHandler(logging.Handler):
         def emit(self, record):
             pass
 
-logging.getLogger(__name__).addHandler(NullHandler())
+logging.getLogger(__name__).addHandler(NullHandler())

dbots/client_filler.py

@@ -1,5 +1,6 @@
 from .errors import ClientException
 
+
 class ClientFiller:
     """A class that gets certain values from a client."""
 
@@ -54,6 +55,7 @@ def shard_count(self) -> int or None:
         """
         return None
 
+
 class DiscordPy(ClientFiller):
     """Represents the client filler for discord.py clients."""
 
@@ -85,9 +87,10 @@ def shard_count(self):
         else:
             return self.client.shard_count
 
+
 ClientFiller.CLIENT_KEYMAP = {
     'discord.py': DiscordPy,
     'discordpy': DiscordPy,
     'd.py': DiscordPy,
     'dpy': DiscordPy,
-}
+}

dbots/errors.py

@@ -5,22 +5,27 @@ class DBotsException(Exception):
     """
     pass
 
+
 class PosterException(DBotsException):
     """Exception that is thrown when the poster encounters an error."""
     pass
 
+
 class ClientException(PosterException):
     """Exception that is thrown when the options for a client is invalid."""
     pass
 
+
 class ServiceException(PosterException):
     """Exception that is thrown when the options for a service is invalid."""
     pass
 
+
 class APIKeyException(PosterException):
     """Exception that is thrown when an API key is invalid."""
     pass
 
+
 class HTTPException(DBotsException):
     """Exception that is thrown when an HTTP request has an error."""
     def __init__(self, response):
@@ -34,30 +39,35 @@ def __init__(self, response):
 
         super().__init__(fmt.format(self.response, self.body))
 
+
 class HTTPForbidden(HTTPException):
     """Exception that's thrown for when status code 403 occurs.
     Subclass of :exc:`HTTPException`
     """
     pass
 
+
 class HTTPUnauthorized(HTTPException):
     """Exception that's thrown for when status code 403 occurs.
     Subclass of :exc:`HTTPException`
     """
     pass
 
+
 class HTTPNotFound(HTTPException):
     """Exception that's thrown for when status code 404 occurs.
     Subclass of :exc:`HTTPException`
     """
     pass
 
+
 class EndpointRequiresToken(DBotsException):
-    """Exception that's thrown for when an endpoint is being used without a token."""
+    """Exception that's thrown for when an endpoint is used without a token."""
     def __init__(self):
         super().__init__('This endpoint requires a token.')
 
+
 class PostingUnsupported(ServiceException):
     """Exception that's thrown for services that cannot be posted to."""
     def __init__(self):
-        super().__init__('This service does not support posting.')
+        super().__init__('This service does not support posting.')

dbots/eventhandler.py

@@ -6,6 +6,7 @@
 
 log = logging.getLogger(__name__)
 
+
 class _ClientEventTask(asyncio.Task):
     def __init__(self, original_coro, event_name, coro, *, loop):
         super().__init__(coro, loop=loop)
@@ -22,8 +23,9 @@ def __repr__(self):
             info.append(('exception', repr(self._exception)))
         return '<ClientEventTask {}>'.format(' '.join('%s=%s' % t for t in info))
 
+
 class EventHandler:
-    def __init__(self, loop = None):
+    def __init__(self, loop=None):
         self.loop = asyncio.get_event_loop() if loop is None else loop
         self._listeners = {}
 
@@ -41,7 +43,7 @@ def event(self, name_or_coro):
             log.debug('%s has successfully been registered as an event', event_name)
             return name_or_coro
         else:
-            def inner(coro): 
+            def inner(coro):
                 if not asyncio.iscoroutinefunction(coro):
                     raise TypeError('event registered must be a coroutine function')
                 if name_or_coro in self._listeners:
@@ -50,7 +52,7 @@ def inner(coro):
                     self._listeners[name_or_coro] = [coro]
                 log.debug('%s has successfully been registered as an event using named decorator', name_or_coro)
                 return coro
-            return inner 
+            return inner
         return
 
     async def _run_event(self, coro, event_name, *args, **kwargs):
@@ -83,4 +85,4 @@ def dispatch(self, event, *args, **kwargs):
         except AttributeError:
             pass
         else:
-            self._schedule_event(coro, event, *args, **kwargs)
+            self._schedule_event(coro, event, *args, **kwargs)

dbots/http.py

@@ -9,6 +9,7 @@
 
 log = logging.getLogger(__name__)
 
+
 class HTTPClient:
     """Represents an HTTP client that can send requests."""
 
@@ -35,7 +36,7 @@ def recreate_session(self):
     async def request(self, method, path, **kwargs):
         # Evaluate kwargs
 
-        if not 'headers' in kwargs:
+        if 'headers' not in kwargs:
             kwargs['headers'] = {
                 'User-Agent': self.user_agent,
             }
@@ -45,7 +46,7 @@ async def request(self, method, path, **kwargs):
         if 'json' in kwargs:
             kwargs['headers']['Content-Type'] = 'application/json'
             kwargs['data'] = HTTPClient.to_json(kwargs.pop('json'))
-        
+
         if self.proxy is not None:
             kwargs['proxy'] = self.proxy
         if self.proxy_auth is not None:
@@ -54,7 +55,7 @@ async def request(self, method, path, **kwargs):
         url = path
         if self.base_url:
             url = self.base_url + path
-        
+
         if 'query' in kwargs:
             url = url + '?' + _encode_query(kwargs['query'])
             del kwargs['query']
@@ -63,7 +64,7 @@ async def request(self, method, path, **kwargs):
             log.debug('%s %s with %s has returned %s', method, url, kwargs.get('data'), r.status)
 
             response = HTTPResponse(r, await r.text(encoding='utf-8'))
-            
+
             if 300 > r.status >= 200:
                 log.debug('%s %s has received %s', method, url, response.body)
                 return response
@@ -124,4 +125,4 @@ def __repr__(self):
             ('method', self.method),
             ('url', self.url)
         ]
-        return '<%s %s>' % (self.__class__.__name__, ' '.join('%s=%r' % t for t in attrs))
+        return '<%s %s>' % (self.__class__.__name__, ' '.join('%s=%r' % t for t in attrs))

dbots/poster.py

@@ -9,6 +9,7 @@
 
 log = logging.getLogger(__name__)
 
+
 class AsyncLoop:
     def __init__(self, timeout, callback):
         self._timeout = timeout
@@ -23,11 +24,13 @@ async def _job(self):
     def cancel(self):
         self._task.cancel()
 
+
 def _ensure_coro(func):
     if not asyncio.iscoroutinefunction(func):
         func = asyncio.coroutine(func)
     return func
 
+
 class Poster(EventHandler):
     """
     A class that posts server count to listing sites.
@@ -66,9 +69,9 @@ class Poster(EventHandler):
 
     def __init__(
         self, client_id, server_count, user_count,
-        voice_connections, on_custom_post = None, **options
+        voice_connections, on_custom_post=None, **options
     ):
-        super().__init__(loop = options.pop('loop', None))
+        super().__init__(loop=options.pop('loop', None))
 
         self._loop = None
         self._client_id = client_id
@@ -81,7 +84,7 @@ def __init__(
 
         proxy = options.pop('proxy', None)
         proxy_auth = options.pop('proxy_auth', None)
-        self.http = HTTPClient(proxy = proxy, proxy_auth = proxy_auth)
+        self.http = HTTPClient(proxy=proxy, proxy_auth=proxy_auth)
         self.api_keys = options.pop('api_keys', {})
 
         setattr(self, 'server_count', _ensure_coro(server_count))
@@ -98,26 +101,26 @@ def __repr__(self):
             ('shard_count', self.shard_count),
         ]
         return '<%s %s>' % (self.__class__.__name__, ' '.join('%s=%r' % t for t in attrs))
-    
+
     # property fill-ins
-    
+
     @property
     def client_id(self) -> str or None:
         """The client ID of the poster."""
         return self._client_id
-    
+
     @property
     def shard_id(self) -> int or None:
         """The shard ID of the poster."""
         return self._shard_id
-    
+
     @property
     def shard_count(self) -> int or None:
         """The shard count of the poster."""
         return self._shard_count
 
     # api key management
-    
+
     def set_key(self, service: str, key: str) -> str:
         """
         Sets an API key.
@@ -155,10 +158,10 @@ def remove_key(self, service: str) -> str:
         key = self.api_keys[service]
         del self.api_keys[service]
         return key
-    
+
     # loop management
-    
-    def start_loop(self, interval = 1800) -> AsyncLoop:
+
+    def start_loop(self, interval=1800) -> AsyncLoop:
         """
         Creates a loop that posts to all services every `n` seconds.
 
@@ -171,14 +174,14 @@ def start_loop(self, interval = 1800) -> AsyncLoop:
         self._loop = AsyncLoop(interval, self.__on_loop)
         log.debug('Started loop %s', interval)
         return self._loop
-    
+
     def kill_loop(self):
         """Cancels the current posting loop."""
         if self._loop:
             log.debug('Ending loop')
             self._loop.cancel()
             self._loop = None
-    
+
     async def __on_loop(self):
         log.debug('Loop ran')
         try:
@@ -193,7 +196,7 @@ async def __on_loop(self):
 
     # post management
 
-    async def post(self, service = None) -> HTTPResponse:
+    async def post(self, service=None) -> HTTPResponse:
         """
         Posts the current clients server count to a service.
 
@@ -206,10 +209,10 @@ async def post(self, service = None) -> HTTPResponse:
         users = await self.user_count()
         connections = await self.voice_connections()
         return await self.manual_post(servers, service, users, connections)
-    
+
     async def manual_post(
-        self, server_count, service = None,
-        user_count = None, voice_connections = None
+        self, server_count, service=None,
+        user_count=None, voice_connections=None
     ) -> HTTPResponse:
         """
         Manually posts a server count to a service.
@@ -227,9 +230,9 @@ async def manual_post(
         """
         if service == 'custom' and hasattr(self, 'on_custom_post'):
             return await self.on_custom_post(
-                self, server_count = server_count,
-                user_count = user_count,
-                voice_connections = voice_connections
+                self, server_count=server_count,
+                user_count=user_count,
+                voice_connections=voice_connections
             )
         if len(self.api_keys) == 0:
             raise APIKeyException('No API Keys available')
@@ -241,9 +244,9 @@ async def manual_post(
             for key in keys:
                 try:
                     responses.append(await self.manual_post(
-                        server_count = server_count,
-                        service = key, user_count = user_count,
-                        voice_connections = voice_connections
+                        server_count=server_count,
+                        service=key, user_count=user_count,
+                        voice_connections=voice_connections
                     ))
                 except Exception as error:
                     responses.append(error)
@@ -270,6 +273,7 @@ async def manual_post(
             self.dispatch('post_fail', error)
             raise error
 
+
 class ClientPoster(Poster):
     """
     A class that posts certain client values to listing sites.
@@ -317,15 +321,15 @@ def __repr__(self):
             ('sharding', self._sharding),
         ]
         return '<%s %s>' % (self.__class__.__name__, ' '.join('%s=%r' % t for t in attrs))
-    
+
     @property
     def client_id(self) -> str or None:
         return self.filler.client_id
-    
+
     @property
     def shard_id(self) -> int or None:
         return self._shard_id or self.filler.shard_id if self._sharding else None
-    
+
     @property
     def shard_count(self) -> int or None:
         return self._shard_count or self.filler.shard_count if self._sharding else None

dbots/service.py

@@ -5,12 +5,13 @@
     quit()
 import dbots
 
+
 # Go to https://requestbin.net and replace the path with the given URL
 class TestService(dbots.Service):
     @staticmethod
     def _post(
-        http_client, bot_id, token, server_count = 0, user_count = 0,
-        voice_connections = 0, shard_count = None, shard_id = None
+        http_client, bot_id, token, server_count=0, user_count=0,
+        voice_connections=0, shard_count=None, shard_id=None
     ):
         payload = {
             'server_count': server_count,
@@ -21,42 +22,50 @@ def _post(
             payload['shard_id'] = shard_id
             payload['shard_count'] = shard_count
         return http_client.request(
-            method = 'POST',
-            path = 'http://requestbin.net/r/XXXXXX',
-            query = { 'id': bot_id },
-            headers = { 'Authorization': token },
-            json = payload
+            method='POST',
+            path='http://requestbin.net/r/XXXXXX',
+            query={'id': bot_id},
+            headers={'Authorization': token},
+            json=payload
         )
 
+
 dbots.Service.SERVICE_KEYMAP['test'] = TestService
 
+
 client = discord.Client()
-poster = dbots.ClientPoster(client, 'discord.py', api_keys = {
+poster = dbots.ClientPoster(client, 'discord.py', api_keys={
     'test': 'token'
 })
 
+
 @poster.event
 async def on_post(response):
     print('Post:', response)
 
+
 @poster.event
 async def on_post_fail(error):
     print('Post Fail:', error)
 
+
 @poster.event
 async def on_auto_post(response):
     print('Auto-Post:', response)
 
+
 @poster.event
 async def on_auto_post_fail(error):
     print('Auto-Post Fail:', error)
 
+
 @client.event
 async def on_ready():
     print('Logged on as', client.user)
     await poster.post()
     poster.start_loop(10)
 
+
 @client.event
 async def on_message(message):
     # don't respond to ourselves
@@ -75,4 +84,5 @@ async def on_message(message):
     if message.content.startswith('p>'):
         await poster.post()
 
-client.run('XXX')
+
+client.run('XXX')

examples/client_poster.py

@@ -2,22 +2,30 @@
 
 client_id = '1234567890'
 
+
 def server_count():
-  return 100
+    return 100
+
 
 def user_count():
-  return 100
+    return 100
+
 
 def voice_connections():
-  return 0
+    return 0
+
 
 def custom_post(poster, server_count, user_count, voice_connections):
-    print(f'[CUSTOM_POST] Poster: {poster}, ServerCount: {server_count}, UserCount: {user_count}, VConnections: {voice_connections}')
+    print(
+        f'[CUSTOM_POST] Poster: {poster}, ServerCount: {server_count},',
+        f'UserCount: {user_count}, VConnections: {voice_connections}'
+    )
+
 
 poster = dbots.Poster(
     client_id, server_count, user_count, voice_connections,
-    on_custom_post = custom_post,
-    api_keys = {
+    on_custom_post=custom_post,
+    api_keys={
         'customservice': '…'
     }
 )

examples/custom_post.py

@@ -1,14 +1,15 @@
 import dbots
 
+
 class CustomService(dbots.Service):
     @staticmethod
     def aliases():
         return ['customservice']
 
     @staticmethod
     def _post(
-        http_client, bot_id, token, server_count = 0, user_count = 0,
-        voice_connections = 0, shard_count = None, shard_id = None
+        http_client, bot_id, token, server_count=0, user_count=0,
+        voice_connections=0, shard_count=None, shard_id=None
     ):
         payload = {
             'server_count': server_count,
@@ -19,26 +20,32 @@ def _post(
             payload['shard_id'] = shard_id
             payload['shard_count'] = shard_count
         return http_client.request(
-            method = 'POST',
-            path = 'http://httpbin.org/post',
-            query = { 'id': bot_id },
-            headers = { 'Authorization': token },
-            json = payload
+            method='POST',
+            path='http://httpbin.org/post',
+            query={'id': bot_id},
+            headers={'Authorization': token},
+            json=payload
         )
 
+
 dbots.Service.SERVICES.append(CustomService)
 
 client_id = '1234567890'
 
+
 def server_count():
-  return 100
+    return 100
+
 
 def user_count():
-  return 100
+    return 100
+
 
 def voice_connections():
-  return 0
+    return 0
+
 
-poster = dbots.Poster(client_id, server_count, user_count, voice_connections, api_keys = {
-    'customservice': '…'
-})
+poster = dbots.Poster(
+    client_id, server_count, user_count, voice_connections, api_keys={
+        'customservice': '…'
+    })

examples/custom_service.py

@@ -3,7 +3,7 @@
 
 requirements = []
 with open('requirements.txt') as f:
-  requirements = f.read().splitlines()
+    requirements = f.read().splitlines()
 
 version = ''
 with open('dbots/__init__.py') as f:
@@ -40,4 +40,4 @@
         'Topic :: Utilities',
     ],
     python_requires='>=3.6',
-)
+)

setup.py

@@ -0,0 +1,12 @@
+[flake8]
+ignore = F401, F403, E251
+exclude =
+    .git,
+    __pycache__,
+    docs/conf.py,
+    build,
+    dist,
+    etc
+show-source = true
+statistics = true
+max-line-length = 127