Feature/black format (#120)

* using `black` formatting

* adding `pre-commit` hooks for black

Author: nklapste

.pre-commit-config.yaml

@@ -0,0 +1,8 @@
+repos:
+
+# Automatic source code formatting
+- repo: https://github.com/psf/black
+  rev: stable
+  hooks:
+  - id: black
+    args: [--safe, --quiet]

.travis.yml

@@ -35,7 +35,16 @@ jobs:
     - python: "pypy2.7-5.10.0"
     - python: "pypy3.5-5.10.0"
     - stage: lint
-      name: "pylint"
+      name: "black"
+      python:
+        - 3.6
+      before_install:
+        - pip install black
+      before_script: skip
+      script:
+        - black --check setup.py tests graypy
+      after_script: skip
+    - name: "pylint"
       python:
         - 3.6
       before_script: skip

docs/conf.py

@@ -9,8 +9,8 @@
 
 # -- Project information -----------------------------------------------------
 
-copyright = '2019, Sever Băneşiu, Nathan Klapstein'
-author = 'Sever Băneşiu, Nathan Klapstein'
+copyright = "2019, Sever Băneşiu, Nathan Klapstein"
+author = "Sever Băneşiu, Nathan Klapstein"
 project = "graypy"
 
 
@@ -19,7 +19,9 @@ def find_version(*file_paths):
     import os
     import re
 
-    with codecs.open(os.path.join(os.path.abspath(os.path.dirname(__file__)), *file_paths), 'r') as fp:
+    with codecs.open(
+        os.path.join(os.path.abspath(os.path.dirname(__file__)), *file_paths), "r"
+    ) as fp:
         version_file = fp.read()
     m = re.search(r"^__version__ = \((\d+), ?(\d+), ?(\d+)\)", version_file, re.M)
     if m:
@@ -35,15 +37,15 @@ def find_version(*file_paths):
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
 extensions = [
-    'sphinx.ext.autodoc',
-    'sphinx.ext.viewcode',
+    "sphinx.ext.autodoc",
+    "sphinx.ext.viewcode",
     "sphinx.ext.intersphinx",
     "sphinx_autodoc_typehints",
 ]
 
-source_suffix = '.rst'
+source_suffix = ".rst"
 
-master_doc = 'index'
+master_doc = "index"
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -55,37 +57,37 @@ def find_version(*file_paths):
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
 # This pattern also affects html_static_path and html_extra_path .
-exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
 
 # The name of the Pygments (syntax highlighting) style to use.
-pygments_style = 'sphinx'
+pygments_style = "sphinx"
 
 
 # -- Options for HTML output -------------------------------------------------
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-html_theme = 'sphinx_rtd_theme'
+html_theme = "sphinx_rtd_theme"
 
 html_theme_options = {
-    'logo_only': False,
-    'display_version': True,
-    'prev_next_buttons_location': 'bottom',
-    'style_external_links': False,
+    "logo_only": False,
+    "display_version": True,
+    "prev_next_buttons_location": "bottom",
+    "style_external_links": False,
     # Toc options
-    'collapse_navigation': True,
-    'sticky_navigation': True,
-    'navigation_depth': 4,
-    'includehidden': True,
-    'titles_only': False
+    "collapse_navigation": True,
+    "sticky_navigation": True,
+    "navigation_depth": 4,
+    "includehidden": True,
+    "titles_only": False,
 }
 
 
 # -- Options for HTMLHelp output ---------------------------------------------
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = 'graypydoc'
+htmlhelp_basename = "graypydoc"
 
 
 # -- Options for LaTeX output ------------------------------------------------
@@ -94,72 +96,85 @@ def find_version(*file_paths):
     # The paper size ('letterpaper' or 'a4paper').
     #
     # 'papersize': 'letterpaper',
-
     # The font size ('10pt', '11pt' or '12pt').
     #
     # 'pointsize': '10pt',
-
     # Additional stuff for the LaTeX preamble.
     #
     # 'preamble': '',
-
     # Latex figure (float) alignment
     #
     # 'figure_align': 'htbp',
 }
 
 # Grouping the document tree into LaTeX files. List of tuples
-# (source start file, target name, title,
-#  author, documentclass [howto, manual, or own class]).
-latex_documents = [
-    (master_doc, 'graypy.tex', 'graypy Documentation',
-     author, 'manual'),
-]
+# (source start file, target name, title, author, documentclass [howto, manual, or own class]).
+latex_documents = [(master_doc, "graypy.tex", "graypy Documentation", author, "manual")]
 
 
 # -- Options for manual page output ------------------------------------------
 
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
-man_pages = [
-    (master_doc, 'graypy', 'graypy Documentation', author.split(", "), 1)
-]
+man_pages = [(master_doc, "graypy", "graypy Documentation", author.split(", "), 1)]
 
 
 # -- Options for Texinfo output ----------------------------------------------
 
 # Grouping the document tree into Texinfo files. List of tuples
-# (source start file, target name, title, author,
-#  dir menu entry, description, category)
+# (
+#     source start file,
+#     target name,
+#     title,
+#     author,
+#     dir menu entry,
+#     description,
+#     category
+# )
 texinfo_documents = [
-    (master_doc, 'graypy', 'graypy Documentation', author, 'graypy',
-     'Python logging handlers that send messages in the Graylog Extended Log Format (GELF).',
-     'Miscellaneous'),
+    (
+        master_doc,
+        "graypy",
+        "graypy Documentation",
+        author,
+        "graypy",
+        "Python logging handlers that send messages in the Graylog Extended Log Format (GELF).",
+        "Miscellaneous",
+    )
 ]
 
 
 # -- Extension configuration -------------------------------------------------
 
 intersphinx_mapping = {
-    'python': ('https://docs.python.org/3', (None, 'python-inv.txt')),
+    "python": ("https://docs.python.org/3", (None, "python-inv.txt"))
 }
 
 
 # -- auto api docs generation --
 
 # order auto doc members by position in source code
-autodoc_member_order = 'bysource'
+autodoc_member_order = "bysource"
 
 
 def run_apidoc(_):
     from sphinx.ext.apidoc import main
     import os
     import sys
-    sys.path.append(os.path.join(os.path.dirname(__file__), '..'))
+
+    sys.path.append(os.path.join(os.path.dirname(__file__), ".."))
     cur_dir = os.path.abspath(os.path.dirname(__file__))
     module = os.path.join(cur_dir, "..", "graypy")
-    main(["--module-first", "--separate", "--implicit-namespaces", module,
-          "--output-dir", os.path.join(cur_dir, "api")])
+    main(
+        [
+            "--module-first",
+            "--separate",
+            "--implicit-namespaces",
+            module,
+            "--output-dir",
+            os.path.join(cur_dir, "api"),
+        ]
+    )
 
 
 def skip(app, what, name, obj, would_skip, options):
@@ -169,5 +184,5 @@ def skip(app, what, name, obj, would_skip, options):
 
 
 def setup(app):
-    app.connect('builder-inited', run_apidoc)
+    app.connect("builder-inited", run_apidoc)
     app.connect("autodoc-skip-member", skip)

graypy/__init__.py

@@ -11,8 +11,14 @@
  + :mod:`.rabbitmq` - RabbitMQ GELF Logging Handler
 """
 
-from graypy.handler import GELFUDPHandler, GELFTCPHandler, GELFTLSHandler, \
-    GELFHTTPHandler, WAN_CHUNK, LAN_CHUNK
+from graypy.handler import (
+    GELFUDPHandler,
+    GELFTCPHandler,
+    GELFTLSHandler,
+    GELFHTTPHandler,
+    WAN_CHUNK,
+    LAN_CHUNK,
+)
 
 try:
     from graypy.rabbitmq import GELFRabbitHandler, ExcludeFilter