Merge pull request #23 from gradhep/feat/move-to-cookie

feat: move to cookiecut project from scikit-hep dev guidlines

.flake8

@@ -0,0 +1,6 @@
+[flake8]
+ignore = E203, E231, E501, E722, W503, B950
+select = C,E,F,W,T,B9,I
+per-file-ignores =
+    __init__.py: D104,
+    setup.py: D100

.github/dependabot.yml

@@ -0,0 +1,11 @@
+version: 2
+updates:
+  # Maintain dependencies for GitHub Actions
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "daily"
+    ignore:
+      # Official actions have moving tags like v1
+      # that are used, so they don't need updates here
+      - dependency-name: "actions/*"

.github/workflows/ci.yml

@@ -0,0 +1,68 @@
+name: CI
+
+on:
+  workflow_dispatch:
+  pull_request:
+  push:
+    branches:
+    - main
+    - develop
+
+jobs:
+  checks:
+    name: Check Python ${{ matrix.python-version }} on ${{ matrix.runs-on }}
+    runs-on: ${{ matrix.runs-on }}
+    needs: [pre-commit]
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: [3.7, 3.8]
+        runs-on: [ubuntu-latest, macos-latest]
+
+
+    steps:
+    - uses: actions/checkout@v2
+
+    - uses: actions/setup-python@v2
+      with:
+        python-version: ${{ matrix.python-version }}
+
+    - name: Install package
+      run: python -m pip install .[test]
+
+    - name: Test package
+      run: python -m pytest -ra --cov-report=xml
+
+    - name: Upload coverage to codecov
+      if: ${{ matrix.python-version == '3.7' && matrix.runs-on == 'ubuntu-latest'}}
+      uses: codecov/codecov-action@v1
+      with:
+        #token: ${{ secrets.CODECOV_TOKEN }}
+        file: ./coverage.xml
+        name: codecov-umbrella
+        fail_ci_if_error: true
+
+  dist:
+    name: Distribution build
+    runs-on: ubuntu-latest
+    needs: [pre-commit]
+
+    steps:
+    - uses: actions/checkout@v1
+
+    - name: Build sdist and wheel
+      run: pipx run build
+
+    - uses: actions/upload-artifact@v2
+      with:
+        path: dist
+
+    - name: Check products
+      run: pip run twine check dist/*
+
+    - uses: pypa/[email protected]
+      if: github.event_name == 'release' && github.event.action == 'published'
+      with:
+        user: __token__
+        # Remember to generate this and set it in "GitHub Secrets"
+        password: ${{ secrets.pypi_password }}

.gitignore

@@ -1,15 +1,3 @@
-*.bak
-.gitattributes
-.last_checked
-.gitconfig
-*.bak
-*.log
-*~
-~*
-_tmp*
-tmp*
-tags
-
 # Byte-compiled / optimized / DLL files
 __pycache__/
 *.py[cod]
@@ -20,7 +8,6 @@ __pycache__/
 
 # Distribution / packaging
 .Python
-env/
 build/
 develop-eggs/
 dist/
@@ -33,9 +20,11 @@ parts/
 sdist/
 var/
 wheels/
+share/python-wheels/
 *.egg-info/
 .installed.cfg
 *.egg
+MANIFEST
 
 # PyInstaller
 #  Usually these files are written by a python script from a template
@@ -50,13 +39,17 @@ pip-delete-this-directory.txt
 # Unit test / coverage reports
 htmlcov/
 .tox/
+.nox/
 .coverage
 .coverage.*
 .cache
 nosetests.xml
 coverage.xml
 *.cover
+*.py,cover
 .hypothesis/
+.pytest_cache/
+cover/
 
 # Translations
 *.mo
@@ -65,6 +58,8 @@ coverage.xml
 # Django stuff:
 *.log
 local_settings.py
+db.sqlite3
+db.sqlite3-journal
 
 # Flask stuff:
 instance/
@@ -77,27 +72,47 @@ instance/
 docs/_build/
 
 # PyBuilder
+.pybuilder/
 target/
 
 # Jupyter Notebook
 .ipynb_checkpoints
+Untitled.ipynb
+
+# IPython
+profile_default/
+ipython_config.py
 
 # pyenv
-.python-version
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
 
-# celery beat schedule file
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
 celerybeat-schedule
+celerybeat.pid
 
 # SageMath parsed files
 *.sage.py
 
-# dotenv
+# Environments
 .env
-
-# virtualenv
 .venv
+env/
 venv/
 ENV/
+env.bak/
+venv.bak/
 
 # Spyder project settings
 .spyderproject
@@ -111,34 +126,17 @@ ENV/
 
 # mypy
 .mypy_cache/
+.dmypy.json
+dmypy.json
 
-.vscode
-*.swp
-
-# osx generated files
-.DS_Store
-.DS_Store?
-.Trashes
-ehthumbs.db
-Thumbs.db
-.idea
-
-# pytest
-.pytest_cache
-
-# tools/trust-doc-nbs
-docs_src/.last_checked
-
-# symlinks to fastai
-docs_src/fastai
-tools/fastai
-
-# link checker
-checklink/cookies.txt
+# Pyre type checker
+.pyre/
 
-# pyhf
-pyhf/
+# pytype static type analyzer
+.pytype/
 
-# .gitconfig is now autogenerated
-.gitconfig
+# Cython debug symbols
+cython_debug/
 
+# setuptools_scm
+src/*/version.py

.pre-commit-config.yaml

@@ -0,0 +1,54 @@
+repos:
+- repo: https://github.com/psf/black
+  rev: 21.5b2
+  hooks:
+  - id: black
+
+- repo: https://github.com/pre-commit/pre-commit-hooks
+  rev: v4.0.1
+  hooks:
+  - id: check-added-large-files
+  - id: check-case-conflict
+  - id: check-merge-conflict
+  - id: check-symlinks
+  - id: check-yaml
+  - id: debug-statements
+  - id: end-of-file-fixer
+  - id: mixed-line-ending
+  - id: requirements-txt-fixer
+  - id: trailing-whitespace
+
+- repo: https://github.com/PyCQA/isort
+  rev: 5.8.0
+  hooks:
+  - id: isort
+
+- repo: https://github.com/asottile/pyupgrade
+  rev: v2.19.3
+  hooks:
+  - id: pyupgrade
+    args: ["--py36-plus"]
+
+- repo: https://github.com/asottile/setup-cfg-fmt
+  rev: v1.17.0
+  hooks:
+  - id: setup-cfg-fmt
+
+- repo: https://github.com/pycqa/flake8
+  rev: 3.9.2
+  hooks:
+  - id: flake8
+    exclude: docs/conf.py
+    additional_dependencies: [flake8-bugbear, flake8-print]
+
+- repo: https://github.com/pre-commit/mirrors-mypy
+  rev: v0.902
+  hooks:
+  - id: mypy
+    files: src
+
+- repo: https://github.com/mgedmin/check-manifest
+  rev: "0.46"
+  hooks:
+  - id: check-manifest
+    stages: [manual]

.readthedocs.yml

@@ -0,0 +1,21 @@
+# .readthedocs.yml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+  configuration: docs/conf.py
+
+# Include PDF and ePub
+formats: all
+
+python:
+  version: 3.8
+  install:
+  - method: pip
+    path: .
+    extra_requirements:
+    - docs