♻ Refactoring

.codeclimate.yml

@@ -0,0 +1,32 @@
+version: "2"
+checks:
+  argument-count:
+    config:
+      threshold: 4
+  complex-logic:
+    config:
+      threshold: 4
+  file-lines:
+    config:
+      threshold: 250
+  method-complexity:
+    config:
+      threshold: 5
+  method-count:
+    config:
+      threshold: 20
+  method-lines:
+    config:
+      threshold: 25
+  nested-control-flow:
+    config:
+      threshold: 4
+  return-statements:
+    config:
+      threshold: 4
+  similar-code:
+    config:
+      threshold: # language-specific defaults. an override will affect all languages.
+  identical-code:
+    config:
+      threshold: # language-specific defaults. an override will affect all languages.

.gitattributes

@@ -0,0 +1 @@
+* text=auto

.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,23 @@
+### Description
+
+<!--
+A detailed description of what is being reported. Please include steps to reproduce the problem.
+
+Things to consider sharing:
+- What version of the package is being used (pip show code-snippet)?
+- What is the host platform and version (e.g. macOS 10.15.2, Windows 10, Ubuntu 18.04 LTS)?
+-->
+
+
+
+### Issue request type
+
+<!--
+Please add only one `x` to one of the following types. Do not fill multiple types (split the issue otherwise).
+
+
+For questions please use https://forums.mbed.com/
+-->
+
+- [ ] Enhancement
+- [ ] Bug

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,17 @@
+### Description
+
+<!--
+Please add any detail or context that would be useful to a reviewer.
+-->
+
+
+
+### Test Coverage
+
+<!--
+Please put an `x` in the correct box e.g. `[x]` to indicate the testing coverage of this change.
+-->
+
+- [ ]  This change is covered by existing or additional automated tests.
+- [ ]  Manual testing has been performed (and evidence provided) as automated testing was not feasible.
+- [ ]  Additional tests are not required for this change (e.g. documentation update).

.gitignore

@@ -1,110 +1,30 @@
-# Byte-compiled / optimized / DLL files
-__pycache__/
-*.py[cod]
-*$py.class
+# Don't lock the versions of this library or installation gridlock will ensue
+Pipfile.lock
 
-# C extensions
-*.so
+# PyCharm
+.idea/
 
-# Distribution / packaging
-.Python
-env/
-build/
-develop-eggs/
-dist/
-downloads/
-eggs/
-.eggs/
-lib/
-lib64/
-parts/
-sdist/
-var/
-wheels/
-*.egg-info/
-.installed.cfg
-*.egg
+# macOS
+.DS_Store
 
-# PyInstaller
-#  Usually these files are written by a python script from a template
-#  before PyInstaller builds the exe, so as to inject date/other infos into it.
-*.manifest
-*.spec
-
-# Installer logs
-pip-log.txt
-pip-delete-this-directory.txt
+# Python
+*.pyc
+__pycache__/
+*.egg-info/
 
-# Unit test / coverage reports
-htmlcov/
-.tox/
+# Coverage.py
 .coverage
-.coverage.*
-.cache
-nosetests.xml
-coverage.xml
-*.cover
-.hypothesis/
-
-# Translations
-*.mo
-*.pot
-
-# Django stuff:
-*.log
-local_settings.py
-
-# Flask stuff:
-instance/
-.webassets-cache
-
-# Scrapy stuff:
-.scrapy
-
-# Sphinx documentation
-docs/_build/
-
-# PyBuilder
-target/
-
-# Jupyter Notebook
-.ipynb_checkpoints
-
-# pyenv
-.python-version
-
-# celery beat schedule file
-celerybeat-schedule
-
-# SageMath parsed files
-*.sage.py
-
-# dotenv
-.env
-
-# virtualenv
-.venv
-venv/
-ENV/
-
-# Spyder project settings
-.spyderproject
-.spyproject
-
-# Rope project settings
-.ropeproject
-
-# mkdocs documentation
-/site
-
-# mypy
-.mypy_cache/
+coverage/
+junit/
+htmlcov/
 
-# pytest
-*.pytest*
+# Package
+build/
+dist/
+release-dist/
 
-# editors
-*.idea
+# Temporary file used by CI
+dev-requirements.txt
 
-# test directory
-tmp_test_dir
+# Local docs output
+local_docs/

.pre-commit-config.yaml

@@ -0,0 +1,52 @@
+- repo: local
+  hooks:
+    - id: assertnews
+      name: news file
+      entry: assert-news -l
+      language: python
+      types: [file]
+      require_serial: true
+      verbose: true
+      always_run: true
+      pass_filenames: false
+
+    - id: licensing
+      name: licensing
+      entry: license-files
+      language: python
+      types: [file]
+      require_serial: true
+      always_run: true
+      verbose: true
+      pass_filenames: false
+
+    - id: black
+      name: black
+      entry: black
+      language: python
+      types: [python]
+      require_serial: true
+
+    - id: flake8
+      name: flake8
+      entry: flake8
+      language: python
+      types: [python]
+      require_serial: true
+
+    - id: mypy
+      name: mypy
+      entry: mypy -p snippet
+      language: python
+      types: [python]
+      require_serial: true
+      pass_filenames: false
+
+    - id: pytest
+      name: pytest
+      entry: pytest -vvv
+      language: python
+      types: [python]
+      pass_filenames: false
+      always_run: true
+

CHANGELOG.md

@@ -1,10 +1,13 @@
 # Changelog
-> This file is autogenerated.
-> Only edit this file directly to correct typos.
-> See [CONTRIBUTING)[./CONTRIBUTING.md] for instructions on adding new entries.
-
-This news file contains a log of notable changes to `snippet`. Please see [code-snippet](https://pypi.org/project/code-snippet/#history>) for
-a list of versions that have been released on PyPI.
+<!--
+This file is autogenerated.
+Only edit this file directly to correct typos.
+See CONTRIBUTING.md for instructions on how new entries get added.
+-->
+
+This document contains a history of significant changes which have been released for `code-snippet`. Please note that
+beta releases are not included in this history. For a full list of all releases, please see the
+[PyPI Release History](https://pypi.org/project/code-snippet/#history).
 
 [//]: # (begin_release_notes)