Refactor: Apply Copier template (#19)

Author: adrien-berchet

.auto-changelog-template.hbs

@@ -123,7 +123,7 @@ Example Definitions
         - {{message}} ({{author}}{{#if href}} - [#{{id}}]({{href}}){{/if}})
       {{/commit-list}}
 
-      {{#commit-list merges heading='### Uncategorized Changes' exclude='[bB]reaking [cC]hange:|[bB]reaking:|^[fF]eat:|^[fF]eat\(|^[fF]ix:|^[fF]ix\(|^[cC]hore:|^[cC]hore\(|^[dD]ocs:|^[dD]ocs\(|^[rR]efactor:|^[rR]efactor\(|^[tT]est:|^[tT]est\(|^[sS]tyle:|^[sS]tyle\(|^[pP]erf:|^[pP]erf\(|\[skip-changelog\]'}}
+      {{#commit-list merges heading='### Uncategorized Changes' exclude='[bB]reaking [cC]hange:|[bB]reaking:|^[fF]eat:|^[fF]eat\(|^[fF]ix:|^[fF]ix\(|^[cC]hore:|^[cC]hore\(|^[cC][iI]:|^[cC][iI]\(|^[dD]ocs:|^[dD]ocs\(|^[rR]efactor:|^[rR]efactor\(|^[tT]est:|^[tT]est\(|^[sS]tyle:|^[sS]tyle\(|^[pP]erf:|^[pP]erf\(|\[skip-changelog\]'}}
         - {{message}} ({{author}}{{#if href}} - [#{{id}}]({{href}}){{/if}})
       {{/commit-list}}
 

.codespellignorelines

@@ -0,0 +1,24 @@
+# Changes here will be overwritten by Copier
+
+_commit: 0.1.7
+_src_path: [email protected]:neuromath/python-template.git
+author_email: ''
+author_name: Blue Brain Project, EPFL
+copyright_license: Apache License 2.0
+copyright_year: '2022'
+download_url: [email protected]:BlueBrain/dir-content-diff.git
+init_git: false
+maintainer: Adrien Berchet (@adrien-berchet)
+package_name: dir_content_diff
+project_description: Simple tool to compare directory contents.
+project_name: dir-content-diff
+project_url: https://dir-content-diff.readthedocs.io
+repository: BlueBrain/dir-content-diff
+repository_provider: github
+support_py37: false
+team_name: ''
+today: 29 August 2022
+tracker_url: https://github.com/BlueBrain/dir-content-diff/issues
+version: 1.1.0
+
+# End of Copier answers

.copier-answers.yml

@@ -1,5 +1,6 @@
 [paths]
-sources =
+source_paths =
 	dir_content_diff
 	*/site-packages/dir_content_diff
+	*/dir_content_diff/dir_content_diff
 	*/dir-content-diff/dir_content_diff

.coveragerc

@@ -0,0 +1,5 @@
+[flake8]
+ignore =
+	E203,  # E203: whitespace before ':'
+	W503  # W503: line break before binary operator
+max-line-length = 100

.flake8

@@ -15,10 +15,11 @@ jobs:
         uses: actions/setup-python@v2
         with:
           python-version: 3.8
-      - name: Build a source tarball
+      - name: Build a wheel and a source tarball
         run: |
-          python setup.py sdist
+          pip install setuptools>=42 wheel setuptools_scm[toml]>=3.4
+          python setup.py sdist bdist_wheel
       - name: Publish distribution package to PyPI
-        uses: pypa/gh-action-pypi-publish@master
+        uses: pypa/gh-action-pypi-publish@release/v1
         with:
           password: ${{ secrets.PYPI_API_TOKEN }}

.github/workflows/publish-sdist.yml

@@ -1,16 +1,19 @@
-name: Run all tox jobs using python3
+name: Run all tox jobs using Python3
 
 on:
-    pull_request:
-    push:
-      branches:
-        - main
+  pull_request:
+  push:
+    branches:
+      - main
+
 jobs:
   build:
+
     runs-on: ubuntu-latest
     strategy:
       matrix:
         python-version: [3.8, 3.9]
+
     steps:
     - uses: actions/checkout@v2
     - name: Set up Python ${{ matrix.python-version }}
@@ -25,6 +28,11 @@ jobs:
     - name: Run tox
       run: |
         tox
+    - name: JUnit Report Action
+      uses: mikepenz/[email protected]
+      if: always() # always run even if the previous step fails
+      with:
+        report_paths: 'reports/pytest-*.xml'
     - name: Upload to codecov
       if: ${{matrix.python-version == '3.8'}}
       uses: codecov/codecov-action@v1

.github/workflows/run-tox.yml

@@ -1,14 +1,42 @@
-**/__pycache__
-*.egg-info
+# data
+.eggs
+.idea
 *.pyc
 *.swp
-._.DS_Store
-.coverage*
+*py~
+*~
+*.egg-info
+
+# Mac related stuff
 .DS_Store
-.eggs
-.tox
+
+# Packaging builds
 build
-coverage.xml
 dist
-doc/build
+
+# tox
+.tox
+
+# coverage
+.coverage
+.coverage*
+coverage.xml
+
+# venv
+venv
+test_venv
+
+# docs
+docs/build
+docs/source/generated
+docs/source/examples
+
+# reports
 reports
+
+# examples
+examples/.ipynb_checkpoints
+
+# Node
+node_modules
+package-lock.json

.gitignore

@@ -2,7 +2,7 @@ default_language_version:
   python: python3.8
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.2.0
+    rev: v4.3.0
     hooks:
       - id: check-added-large-files
       - id: check-case-conflict
@@ -13,7 +13,7 @@ repos:
       - id: end-of-file-fixer
       - id: trailing-whitespace
   - repo: https://github.com/alessandrojcm/commitlint-pre-commit-hook
-    rev: v8.0.0
+    rev: v9.0.0
     hooks:
         - id: commitlint
           stages:
@@ -24,19 +24,20 @@ repos:
     hooks:
       - id: isort
   - repo: https://github.com/psf/black
-    rev: 22.3.0
+    rev: 22.6.0
     hooks:
       - id: black
   - repo: https://github.com/codespell-project/codespell
     rev: v2.1.0
     hooks:
       - id: codespell
+        args: ["-x", ".codespellignorelines"]
   - repo: https://github.com/PyCQA/pydocstyle
     rev: 6.1.1
     hooks:
       - id: pydocstyle
         additional_dependencies: ["toml"]
   - repo: https://github.com/PyCQA/flake8
-    rev: 4.0.1
+    rev: 5.0.4
     hooks:
       - id: flake8

.pre-commit-config.yaml

@@ -0,0 +1,52 @@
+[MESSAGES CONTROL]
+disable=
+	arguments-differ,
+	invalid-name,
+
+[FORMAT]
+# Regexp for a line that is allowed to be longer than the limit.
+ignore-long-lines=\bhttps?://\S
+# Maximum number of characters on a single line.
+max-line-length=100
+
+[DESIGN]
+# Maximum number of arguments for function / method
+max-args=10
+# Argument names that match this expression will be ignored. Default to name
+# with leading underscore
+ignored-argument-names=args|kwargs|_.*
+# Maximum number of locals for function / method body
+max-locals=25
+# Maximum number of return / yield for function / method body
+max-returns=6
+# Maximum number of branch for function / method body
+max-branches=20
+# Maximum number of statements in function / method body
+max-statements=50
+# Maximum number of parents for a class (see R0901).
+max-parents=7
+# Maximum number of attributes for a class (see R0902).
+max-attributes=40
+# Minimum number of public methods for a class (see R0903).
+min-public-methods=0
+# Maximum number of public methods for a class (see R0904).
+max-public-methods=60
+
+[SIMILARITIES]
+# checks for similarities and duplicated code. This computation may be
+# memory / CPU intensive, so you should disable it if you experiments some
+# problems.
+
+# Minimum lines number of a similarity.
+min-similarity-lines=25
+# Ignore comments when computing similarities.
+ignore-comments=yes
+# Ignore docstrings when computing similarities.
+ignore-docstrings=yes
+
+[TYPECHECK]
+# List of classes names for which member attributes should not be checked
+# (useful for classes with attributes dynamically set).
+
+# as of numpy 1.8.0, name resolution seems to be a problem. Ignore lookups in numpy
+# ignored-classes=numpy,list