Merge pull request #1 from wpk-nist-gov/feature/new-upstream

new upstream

.editorconfig

@@ -20,5 +20,25 @@ insert_final_newline = false
 [Makefile]
 indent_style = tab
 
-[*.{diff,patch}]
+[*.mk]
+indent_style = tab
+
+[*.{yaml,yml}]
+indent_size = 2
+
+[*.ini]
+indent_size = 4
+
+[*.json]
+indent_size = 2
+
+
+[*.txt]
+indent_size = 4
+trim_trailing_whitespace = false
+
+
+[*.md]
+indent_size = 2
+max_line_length = 80
 trim_trailing_whitespace = false

.github/ISSUE_TEMPLATE.md

@@ -1,14 +1,17 @@
-* Date you used Cookiecutter PyPackage:
-* Cookiecutter version used, if any:
-* Python version, if any:
-* Operating System:
+<!-- markdownlint-disable MD041 -->
+
+- Date you used Cookiecutter PyPackage:
+- Cookiecutter version used, if any:
+- Python version, if any:
+- Operating System:
 
 ### Description
 
-Describe what you were trying to get done. Tell us what happened, what went wrong, and what you expected to happen.
+Describe what you were trying to get done. Tell us what happened, what went
+wrong, and what you expected to happen.
 
 ### What I Did
 
-```
+```bash
 Paste the command(s) you ran and the output.
 ```

.gitignore

@@ -3,30 +3,6 @@ __pycache__/
 *.py[cod]
 *$py.class
 
-# OSX useful to ignore
-*.DS_Store
-.AppleDouble
-.LSOverride
-
-# Thumbnails
-._*
-
-# Files that might appear in the root of a volume
-.DocumentRevisions-V100
-.fseventsd
-.Spotlight-V100
-.TemporaryItems
-.Trashes
-.VolumeIcon.icns
-.com.apple.timemachine.donotpresent
-
-# Directories potentially created on remote AFP share
-.AppleDB
-.AppleDesktop
-Network Trash Folder
-Temporary Items
-.apdisk
-
 # C extensions
 *.so
 
@@ -44,6 +20,7 @@ lib64/
 parts/
 sdist/
 var/
+wheels/
 *.egg-info/
 .installed.cfg
 *.egg
@@ -61,12 +38,14 @@ pip-delete-this-directory.txt
 # Unit test / coverage reports
 htmlcov/
 .tox/
+.nox/
+envs/
 .coverage
 .coverage.*
 .cache
 nosetests.xml
 coverage.xml
-*,cover
+*.cover
 .hypothesis/
 .pytest_cache/
 
@@ -76,26 +55,68 @@ coverage.xml
 
 # Django stuff:
 *.log
+local_settings.py
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
 
 # Sphinx documentation
 docs/_build/
 
-# IntelliJ Idea family of suites
-.idea
-*.iml
-## File-based project format:
-*.ipr
-*.iws
-## mpeltonen/sbt-idea plugin
-.idea_modules/
-
 # PyBuilder
 target/
 
-# Cookiecutter
-output/
-python_boilerplate/
-cookiecutter-pypackage-env/
+# 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/
 
 # IDE settings
-.vscode/
+.vscode/
+pyrightconfig.json
+.autoenv.zsh
+.autoenv_leave.zsh
+config/userconfig.toml
+cruft.patch
+/docs/**/generated/
+/monkeytype.sqlite3
+/dist-conda/
+/tmp/
+/cookiecutter-nist-python-feedstock*/
+/src/**/_version.py
+tuna-loadtime.log
+/requirements/py*-dev.yaml
+/requirements/lock/py*-dev-conda-lock.yml
+/mypackage/

.markdownlint.yaml

@@ -0,0 +1,6 @@
+# Example markdownlint configuration with all properties set to their default value
+
+# Default state for all rules
+default: true
+# disable rules?
+# MD026: false

.pre-commit-config.yaml

@@ -0,0 +1,145 @@
+---
+# pre-commit install
+# pre-commit run --all-files
+# See https://pre-commit.com for more information
+# See https://pre-commit.com/hooks.html for more hooks
+default_install_hook_types:
+  - pre-commit
+  - commit-msg
+exclude: "^{{cookiecutter.project_name}}"
+repos:
+  # * Top level
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.4.0
+    hooks:
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: check-added-large-files
+      - id: check-yaml
+      - id: check-json
+      - id: check-merge-conflict
+      - id: check-symlinks
+      - id: check-toml
+  # * sync dependencies
+  # Put this first, because messes up formatting
+  - repo: https://github.com/mxr/sync-pre-commit-deps
+    rev: v0.0.1
+    hooks:
+      - id: sync-pre-commit-deps
+
+  # * Prettier
+  - repo: https://github.com/pre-commit/mirrors-prettier
+    rev: "v3.0.3"
+    hooks:
+      - id: prettier
+        stages: [commit]
+        additional_dependencies:
+          - prettier-plugin-toml
+        exclude: ^requirements/lock/.*[.]yml
+
+  # * Markdown
+  - repo: https://github.com/DavidAnson/markdownlint-cli2
+    rev: v0.9.2
+    hooks:
+      - id: markdownlint-cli2
+        args: ["--style prettier"]
+
+  # * Linting
+  - repo: https://github.com/charliermarsh/ruff-pre-commit
+    # Ruff version.
+    rev: "v0.0.289"
+    hooks:
+      - id: ruff
+  - repo: https://github.com/psf/black
+    rev: 23.9.1
+    hooks:
+      # NOTE: nbQA for notebook formatting
+      - id: black
+  - repo: https://github.com/adamchainz/blacken-docs
+    rev: "1.16.0"
+    hooks:
+      - id: blacken-docs
+        additional_dependencies:
+          - black==23.9.1
+        # exclude: ^README.md
+  - repo: https://github.com/nbQA-dev/nbQA
+    rev: 1.7.0
+    hooks:
+      - id: nbqa-ruff
+        additional_dependencies: [ruff==0.0.289]
+      - id: nbqa-black
+        additional_dependencies: [black==23.9.1]
+
+  # * Commit message
+  - repo: https://github.com/commitizen-tools/commitizen
+    rev: 3.9.0
+    hooks:
+      - id: commitizen
+        stages: [commit-msg]
+
+  # * Manual Linting ------------------------------------------------------------
+  # * isort, pyupgrade, flake8 defer to ruff
+  - repo: https://github.com/PyCQA/isort
+    rev: 5.12.0
+    hooks:
+      - id: isort
+        stages: [manual]
+  - repo: https://github.com/asottile/pyupgrade
+    rev: v3.10.1
+    hooks:
+      - id: pyupgrade
+        stages: [manual]
+        args: [--py38-plus]
+  - repo: https://github.com/pycqa/flake8
+    rev: 6.1.0
+    hooks:
+      - id: flake8
+        stages: [manual]
+        additional_dependencies:
+          - flake8-docstrings
+          - Flake8-pyproject
+          # - pep8-naming
+          # - flake8-rst-docstrings
+        exclude: ^tests/|^src/mypackage/tests/|^docs/conf.py|^setup.py
+  - repo: https://github.com/nbQA-dev/nbQA
+    rev: 1.7.0
+    hooks:
+      - id: nbqa-pyupgrade
+        additional_dependencies: [pyupgrade]
+        stages: [manual]
+        args: [--py38-plus]
+      - id: nbqa-isort
+        additional_dependencies: [isort]
+        stages: [manual]
+  # ** spelling
+  - repo: https://github.com/codespell-project/codespell
+    rev: v2.2.5
+    hooks:
+      - id: codespell
+        types_or: [python, rst, markdown, cython, c]
+        additional_dependencies: [tomli]
+        args: [-I, docs/spelling_wordlist.txt]
+        stages: [manual]
+
+  # - repo: local
+  #   hooks:
+  #     - id: mypy
+  #       name: mypy
+  #       entry: tox
+  #       args: ["-e", "lint-mypy"]
+  #       language: system
+  #       pass_filenames: false
+  #       # additional_dependencies: [tox]
+  #       types: [python]
+  #       require_serial: true
+  #       stages: [manual]
+  #     - id: pyright
+  #       name: pyright
+  #       entry: pyright
+  #       args: []
+  #       language: system
+  #       pass_filenames: true
+  #       # additional_dependencies: [tox]
+  #       types: [python]
+  #       require_serial: true
+  #       stages: [manual]

.prettierrc.yaml

@@ -0,0 +1 @@
+proseWrap: "always"

AUTHORS.md

@@ -0,0 +1,9 @@
+# Credits
+
+## Development Lead
+
+- William P. Krekelberg <wpk@nist.gov>
+
+## Contributors
+
+None yet. Why not be the first?

CHANGELOG.md

@@ -0,0 +1,13 @@
+<!-- markdownlint-disable MD024 -->
+
+# Changelog
+
+Changelog for `mypackage`
+
+## Unreleased
+
+[changelog.d]: https://github.com/wpk-nist-gov/mypackage
+
+See the fragment files in [changelog.d]
+
+<!-- scriv-insert-here -->