initial commit

.pre-commit-config.yaml

@@ -0,0 +1,107 @@
+repos:
+
+
+-   repo: https://github.com/pre-commit/mirrors-autopep8
+    rev: v1.5.4
+    hooks:
+    - id: autopep8
+      description: "Applies a subset of autopep8's fixes to Python code"
+      args:
+      - --in-place
+      # enable max aggresiveness because all the errors are hand picked
+      - -aaa
+      - --max-line-length
+      - "100"
+      - --select
+      # autopep8 is used for structure rather than style here, which is why only a few error codes are
+      # selected
+      - W292,E502,E266,E402,E713,E714,E721,E722,E731
+
+
+-   repo: https://github.com/psf/black
+    rev: 20.8b1
+    hooks:
+    -   id: black
+        description: "Runs black over Python code"
+        args: ["--target-version", "py38", "--line-length", "100"]
+
+
+-   repo: https://github.com/myint/docformatter
+    rev: v1.3.1
+    hooks:
+    -   id: docformatter
+        name: docformatter
+        description: 'Formats docstrings to follow PEP 257.'
+        entry: docformatter
+        language: python
+
+
+-   repo: https://github.com/PyCQA/pydocstyle.git
+    rev: 5.1.1
+    hooks:
+    -   id: pydocstyle
+        name: pydocstyle
+        description: "Runs pydocstyle over Python code"
+        entry: pydocstyle
+        language: python
+        language_version: python3
+        exclude: "setup.py"
+        types: [python]
+        # -e enables more verbose explainations of errors
+        args: ["-e", "--convention=numpy", "--add-ignore", "D100,D101,D102,D103,D104,D105,D106,D107"]
+
+
+-   repo: https://github.com/humitos/mirrors-autoflake
+    rev: v1.3
+    hooks:
+    - id: autoflake
+      name: autoflake
+      description: "Runs autoflake over Python code"
+      entry: autoflake
+      language: python
+      language_version: python3
+      types: [python]
+      args: ["--in-place", "--remove-unused-variables", "--remove-all-unused-imports", "--remove-duplicate-keys", "--exclude", "__init__.py"]
+
+
+-   repo: https://github.com/PyCQA/flake8
+    rev: 3.8.3
+    hooks:
+    - id: flake8
+      name: flake8
+      description: "Runs flake8 over Python code"
+      entry: flake8
+      language: python
+      language_version: python3
+      types: [python]
+      # http://flake8.pycqa.org/en/latest/user/error-codes.html
+      # F631	assertion test is a tuple, which are always True
+      # F721	doctest syntax error
+      # F821	undefined name
+      # F822	undefined name in __all__
+      # F823	local variable name … referenced before assignment
+      # F901	raise NotImplemented should be raise NotImplementedError
+      # "We also report one extra error: E999. We report E999 when we fail to compile a file into an
+      #  Abstract Syntax Tree for the plugins that require it."
+      args: ["--select=F631,F721,F821,F822,F823,E901,E999"]
+
+
+-   repo: https://github.com/pre-commit/mirrors-mypy
+    rev: v0.782
+    hooks:
+    - id: mypy
+      description: "Runs mypy over Python code"
+      args:
+      - "--disallow-untyped-defs"
+      - "--no-implicit-optional"
+      - "--ignore-missing-imports"
+      - "--warn-redundant-casts"
+      - "--warn-unused-ignores"
+      - "--show-error-context"
+
+
+-   repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v3.2.0
+    hooks:
+    -   id: check-json
+    -   id: trailing-whitespace

AUTHORS.md

@@ -0,0 +1,3 @@
+# Authors
+
+* Gabriel Altay (github: galtay)

CODE_OF_CONDUCT.md

@@ -0,0 +1,128 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[email protected].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior,  harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct
+enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at
+https://www.contributor-covenant.org/translations.

CONTRIBUTING.md

@@ -0,0 +1,20 @@
+# Contributing
+
+Thank you for taking the time to contribute to this project!
+
+## Code of Conduct
+
+This project adheres to the Contributor Covenant [code of conduct](CODE_OF_CONDUCT.md).
+By participating, you are expected to uphold this code.
+Please report unacceptable behavior to [email protected].
+
+## Style Guide
+
+Please install [pre-commit](pre-commit.com) before making any pull requests. This will
+run a suite of linters, type checkers, and auto formatters on any code you wish to
+contribute to the project.
+
+```bash
+pip install pre-commit
+pre-commit install
+```