Add precommit Black, run Black, and add PR template (#109)

Author: adrianlacour-indico

.github/pull_request_template.md

@@ -0,0 +1,33 @@
+## Summary
+
+Please include a summary of the change and what the PR is trying to accomplish.
+List any dependencies that are required for this change.
+
+## Changelog (optional)
+List of changes, to easily get an idea of what was done.
+
+Example:
+- Created new route `awesome_new_route_of_doom`
+- Create alembic migration for new table, `every_table_but_combined`
+
+## Type of change
+
+Please delete options that are not relevant.
+
+- [ ] Bug fix (non-breaking change which fixes an issue)
+- [ ] New feature (non-breaking change which adds functionality)
+- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
+- [ ] This change requires a documentation update
+
+## Checklist:
+A quick checklist of things that should be done before the code is opened to review by others on the team.
+Delete any that are not applicable.
+
+- [ ] Jira story/task is put into PR title
+- [ ] Code has been self-reviewed
+- [ ] Hard-to-understand areas have been commented
+- [ ] Documentation has been updated
+- [ ] My changes generate no new warnings
+- [ ] Unit tests have been added for base functionality and known edge cases
+- [ ] Any dependent changes have been merged and published in downstream modules
+- [ ] Any new GraphQL routes have descriptions for variables

.pre-commit-config.yaml

@@ -0,0 +1,12 @@
+repos:
+-   repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v2.3.0
+    hooks:
+    -   id: check-yaml
+    -   id: end-of-file-fixer
+    -   id: trailing-whitespace
+-   repo: https://github.com/psf/black
+    rev: 19.3b0
+    hooks:
+    -   id: black
+        language_version: python3

docsrc/conf.py

@@ -13,17 +13,17 @@
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
 
-sys.path.insert(0, os.path.abspath('../'))
+sys.path.insert(0, os.path.abspath("../"))
 
 
 # -- Project information -----------------------------------------------------
 
-project = 'Indico Python Client'
-copyright = '2020, Indico'
-author = 'Indico'
+project = "Indico Python Client"
+copyright = "2020, Indico"
+author = "Indico"
 
 # The full version, including alpha/beta/rc tags
-release = '3.1.0'
+release = "3.1.0"
 
 
 # -- General configuration ---------------------------------------------------
@@ -32,35 +32,35 @@
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
 extensions = [
-    'sphinx_rtd_theme',
-    'sphinx.ext.autodoc',
-    'sphinx.ext.napoleon',
-    'sphinx_autodoc_typehints'
+    "sphinx_rtd_theme",
+    "sphinx.ext.autodoc",
+    "sphinx.ext.napoleon",
+    "sphinx_autodoc_typehints",
 ]
 
 # Add any paths that contain templates here, relative to this directory.
-templates_path = ['_templates']
+templates_path = ["_templates"]
 
 # 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"]
 
 
 # -- 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"
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['_static']
-html_style = 'css/indicotheme.css'
-html_logo = './_static/logo-white.png'
-html_favicon = './_static/favicon.png'
+html_static_path = ["_static"]
+html_style = "css/indicotheme.css"
+html_logo = "./_static/logo-white.png"
+html_favicon = "./_static/favicon.png"
 html_theme_options = {
-    'style_nav_header_background': 'linear-gradient(to right top,#2c4658,#2f5f76,#2b7992,#2094ad,#04b1c6)'
-}
+    "style_nav_header_background": "linear-gradient(to right top,#2c4658,#2f5f76,#2b7992,#2094ad,#04b1c6)"
+}

examples/ocr-object-parsing.py

@@ -14,26 +14,25 @@
 
 files_to_extract = client.call(
     DocumentExtraction(
-        files=['./test_paragraphs.pdf'], 
-        json_config={'preset_config': 'standard'}
+        files=["./test_paragraphs.pdf"], json_config={"preset_config": "standard"}
     )
 )
 extracted_file = client.call(JobStatus(id=files_to_extract[0].id, wait=True))
 json_result = client.call(RetrieveStorageObject(extracted_file.result))
 
-# The code below shows how to get the OCR text from the 'json_result' object. 
+# The code below shows how to get the OCR text from the 'json_result' object.
 # Note: it may vary slightly if you use DocumentExtraction configurations other than 'standard'
 
 # Full Text
-full_document_text = json_result['text'] 
+full_document_text = json_result["text"]
 
 # Doucment Text split by page
 text_by_page = list()
-for page in json_result['pages']:
-    text_by_page.append(page['text'])
+for page in json_result["pages"]:
+    text_by_page.append(page["text"])
 
 # Document Text split by block (or paragraph)
 text_by_block = list()
-for page in json_result['pages']:
-    for block in page['blocks']:
-        text_by_block.append(block['text'])
+for page in json_result["pages"]:
+    for block in page["blocks"]:
+        text_by_block.append(block["text"])

examples/submission.py

@@ -85,9 +85,7 @@
 Requires auto-review is enabled for workflow
 """
 submission_ids = client.call(
-    WorkflowSubmission(
-        workflow_id=workflow_id, files=["my_file.pdf"]
-    )
+    WorkflowSubmission(workflow_id=workflow_id, files=["my_file.pdf"])
 )
 submissions = client.call(WaitForSubmissions(submission_ids))
 submission = submissions[0]

examples/train-classification-model.py

@@ -18,9 +18,7 @@
         name="my_classification_model",
         dataset_id=dataset.id,
         source_column_id=dataset.datacolumn_by_name("text").id,  # csv text column
-        labelset_id=dataset.labelset_by_name(
-            "Target_1"
-        ).id,  # csv target class column
+        labelset_id=dataset.labelset_by_name("Target_1").id,  # csv target class column
         wait=True,  # wait for training to finish
     )
 )

examples/workflow.py

@@ -21,7 +21,11 @@
     # Send a document through the workflow
     # Get back one Job per file
     jobs = client.call(
-        WorkflowSubmission(workflow_id=workflows[0].id, files=["./path/to/sample.pdf"], submission=False)
+        WorkflowSubmission(
+            workflow_id=workflows[0].id,
+            files=["./path/to/sample.pdf"],
+            submission=False,
+        )
     )
     job = jobs[0]
 

indico/__init__.py

@@ -2,11 +2,12 @@
 from indico._version import get_versions
 
 logging.basicConfig()
-Version = version = __version__ = VERSION = get_versions()['version']
+Version = version = __version__ = VERSION = get_versions()["version"]
 
 from indico.client import *
 from indico.client.request import *
 
 from ._version import get_versions
-__version__ = get_versions()['version']
+
+__version__ = get_versions()["version"]
 del get_versions