Add initial files (#1)

* Add config files

* Add project's toml

* Add empty project code dirs

* Add pre-commit hook

* Add Makefile

* Add build pipeline

Author: piotr-rarus

.coveragerc

@@ -0,0 +1,26 @@
+[run]
+source=src
+
+[report]
+exclude_lines =
+    # Have to re-enable the standard pragma
+    pragma: no cover
+
+    # Don't complain about missing debug-only code:
+    def __repr__
+    if self\.debug
+
+    # Don't complain if tests don't hit defensive assertion code:
+    raise AssertionError
+    raise NotImplementedError
+
+    # Don't complain if non-runnable code isn't run:
+    if 0:
+    if __name__ == .__main__.:
+
+ignore_errors = True
+
+omit =
+    */tests/*
+    */test/*
+    */cli/*

.env.dev.example

@@ -0,0 +1,4 @@
+[flake8]
+max-line-length = 88
+extend-ignore = E203
+include = src

.env.example

@@ -0,0 +1,40 @@
+exclude: '.git|.tox'
+default_stages: [commit]
+fail_fast: true
+
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.0.1
+    hooks:
+      - id: check-ast
+      - id: check-case-conflict
+      - id: check-docstring-first
+      - id: check-json
+      - id: check-merge-conflict
+      - id: check-toml
+      - id: check-xml
+      - id: check-yaml
+      - id: detect-private-key
+      - id: end-of-file-fixer
+      - id: no-commit-to-branch
+        args: ['--branch', 'master']
+      - id: pretty-format-json
+      - id: trailing-whitespace
+
+  - repo: https://github.com/timothycrosley/isort
+    rev: 5.10.1
+    hooks:
+      - id: isort
+        name: isort (python)
+
+  - repo: https://github.com/psf/black
+    rev: 22.3.0
+    hooks:
+    - id: black
+      language_version: python3.8
+
+  - repo: https://gitlab.com/pycqa/flake8
+    rev: 4.0.1
+    hooks:
+      - id: flake8
+        additional_dependencies: [flake8-isort]

.flake8

@@ -0,0 +1,57 @@
+name: build
+
+on: [push, pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+  
+    steps:
+
+    - name: Checkout repository
+      uses: actions/checkout@v2
+
+    - name: Set up Python 3.9
+      uses: actions/setup-python@v2
+      with:
+        python-version: 3.9
+
+    - name: Install Poetry
+      uses: snok/install-poetry@v1
+      with:
+        virtualenvs-in-project: true
+        virtualenvs-path: .venv
+
+    - name: Cache Poetry
+      uses: actions/cache@v3
+      with:
+        path: .venv
+        key: venv-${{ runner.os }}-${{ steps.setup-python.outputs.python-version }}-${{ hashFiles('**/poetry.lock') }}
+
+    - name: Install dependencies
+      if: steps.cached-poetry-dependencies.outputs.cache-hit != 'true'
+      run: poetry install --no-interaction --no-root
+
+    - name: Linter
+      run: |
+        poetry run flake8 src
+
+    - name: Mypy
+      run: |
+        poetry run mypy --incremental --show-error-codes --pretty src
+
+    - name: Tests
+      run: |
+        poetry run coverage run -m pytest src --cov-config=.coveragerc --junit-xml=junit/test-results.xml --cov-report=html --cov-report=xml
+
+    - name: Tests Coverage
+      run: |
+        poetry run coverage html
+        poetry run coverage xml
+        poetry run coverage report --show-missing
+
+    # Upload your code coverage here
+    # - name: Upload codecov
+    #   uses: codecov/codecov-action@v1
+    #   with:
+    #     fail_ci_if_error: true

.github/hooks/.pre-commit-config.yml

@@ -0,0 +1,109 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# 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
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+
+# 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
+
+# Environments
+.env
+.venv
+.envrc
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+
+# Project's custom
+.vscode/
+.idea/

.github/workflows/build.yml

@@ -0,0 +1,7 @@
+[settings]
+multi_line_output = 3
+include_trailing_comma = True
+force_grid_wrap = 0
+use_parentheses = True
+ensure_newline_before_comments = True
+line_length = 88

.gitignore

@@ -0,0 +1,45 @@
+# Installation
+setup_venv:
+	poetry install --no-root
+
+install_pre_commit:
+	poetry run pre-commit install -c .github/hooks/.pre-commit-config.yml
+
+install_dev: setup_venv install_pre_commit
+
+# Dev tools
+isort:
+	poetry run isort src
+
+black:
+	poetry run black --config pyproject.toml src
+
+# pre-commit flake8 runs only against staged files
+flake8:
+	poetry run flake8 src
+
+format: isort black
+
+mypy:
+	poetry run mypy --incremental --show-error-codes --pretty src
+
+pre_commit:
+	poetry run pre-commit run -a -c .github/hooks/.pre-commit-config.yml
+
+test:
+	poetry run pytest src
+
+test_cov:
+	poetry run coverage run -m pytest src --cov-config=.coveragerc --junit-xml=junit/test-results.xml --cov-report=html --cov-report=xml
+	poetry run coverage html
+	poetry run coverage xml
+	poetry run coverage report --show-missing
+
+compile_env:
+	poetry lock --no-update
+
+build: isort black pre_commit flake8 mypy test
+
+# Misc
+jupyter:
+	poetry run jupyter notebook

.isort.cfg

@@ -1 +1,53 @@
 # python-template
+
+## Developer Guide
+
+Setup your local environment:
+
+```sh
+make install_dev
+```
+
+This command will create local `.venv` managed by `poetry` and install `pre-commit`.
+
+### [pre-commit](.github/hooks/.pre-commit-config.yml)
+
+- syntax checks
+- no commit to master
+- `isort`
+- `black`
+- `flake8`
+
+### [Makefile](Makefile)
+
+- `setup_venv`
+- `install_pre_commit`
+- `install_dev`: : `setup_venv` `install_pre_commit`
+- `isort`
+- `black`
+- `flake8`
+- `format`: `isort` `black`
+- `mypy`
+- `pre_commit`
+- `test`
+- `test_cov`
+- `compile_env`
+- `build`: `isort` `black` `pre_commit` `flake8` `mypy` `test`
+
+To quickly format repo while coding run:
+
+```sh
+make format
+```
+
+It's also useful to run `flake8` as `pre-commit` runs it only against staged files.
+
+```sh
+make flake8
+```
+
+Before you commit, it's good to run a full check:
+
+```sh
+make build
+```