🔧 Improve packaging tooling (#923)

* 🩹 Changed old HISTORY.rst to changelog.md in manifest
* 🔧 Added 'check-manifest' pre-commit hook to check for missing files in the distribution
* 📚 Add change to changelog

Co-authored-by: Joris Snellenburg <jsnel@users.noreply.github.com>

.pre-commit-config.yaml

@@ -145,3 +145,8 @@ repos:
         types: [file]
         types_or: [python, pyi, markdown, rst, jupyter]
         args: [-L doas]
+
+  - repo: https://github.com/mgedmin/check-manifest
+    rev: "0.47"
+    hooks:
+      - id: check-manifest

MANIFEST.in

@@ -1,6 +1,6 @@
 include AUTHORS.rst
 include CONTRIBUTING.rst
-include HISTORY.rst
+include changelog.md
 include LICENSE
 include README.md
 setup.cfg

changelog.md

@@ -14,6 +14,8 @@
 
 ### 🚧 Maintenance
 
+- 🔧 Improve packaging tooling (#923)
+
 ## 0.5.1 (2021-12-31)
 
 ### 🩹 Bug fixes

pyproject.toml

@@ -26,7 +26,12 @@ force_single_line = true
 remove_redundant_aliases = true
 
 [tool.interrogate]
-exclude = ["setup.py", "docs", "*test/*", "benchmark/*"]
+exclude = [
+  "setup.py",
+  "docs",
+  "*test/*",
+  "benchmark/*"
+]
 ignore-init-module = true
 fail-under = 59
 
@@ -67,3 +72,22 @@ exclude_lines = [
   'if __name__ == .__main__.:',
   'if TYPE_CHECKING:'
 ]
+
+[tool.check-manifest]
+ignore = [
+  "benchmark/**/*",
+  "binder/**/*",
+  "docs/**/*",
+  "*/.pytest_cache/**/*",
+  "*/.mypy_cache/**/*",
+  ".git-blame-ignore-revs",
+  ".gitignore",
+  ".pre-commit-config.yaml",
+  ".sonarcloud.properties",
+  ".sourcery.yaml",
+  ".zenodo.json",
+  "codecov.yml",
+  "readthedocs.yml",
+  "requirements_dev.txt",
+  "tox.ini",
+]