Merge pull request #28 from velexi-research/dev/0.6.3

Polish .gitignore. Polish pre-commit configuration.
velexi-research · Jun 19, 2023 · 9a8beea · 9a8beea
2 parents f2b356a + 4efa27e
commit 9a8beea
Show file tree

Hide file tree

Showing 6 changed files with 54 additions and 27 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,4 +1,16 @@
-# --- Python files
+# --- Environments
+
+# direnv
+.direnv
+.envrc
+
+# conda
+.conda
+
+# Python virtual environment
+.venv
+
+# --- Python
 
 # compiled code
 __pycache__/
@@ -12,18 +24,6 @@ htmlcov/
 .pytest_cache
 .tox/
 
-# --- Environments
-
-# direnv
-.direnv
-.envrc
-
-# conda
-.conda
-
-# common manually-created Python virtual environments
-.venv
-
 # --- Code editors
 
 # VS Code

diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -6,13 +6,13 @@ repos:
       entry: black
       language: python
       types: [python]
-      exclude: ^{{cookiecutter.project_name}}
+      exclude: ^spikes
     - id: flake8
       name: flake8
       entry: flake8
       language: python
       types: [python]
-      exclude: ^{{cookiecutter.project_name}}|^spikes
+      exclude: ^spikes
   - repo: https://github.com/pre-commit/pre-commit-hooks
     rev: v2.5.0
     hooks:

diff --git a/RELEASE-NOTES.md b/RELEASE-NOTES.md
@@ -1,6 +1,17 @@
 Velexi Python Package Cookiecutter Release Notes
 ================================================
 
+-------------------------------------------------------------------------------
+0.6.3 (2023-06-19)
+==================
+### Cookiecutter Template
+* Polish .gitignore.
+* Polish pre-commit configuration.
+
+### Cookiecutter Development
+* Polish .gitignore.
+* Polish pre-commit configuration.
+
 -------------------------------------------------------------------------------
 0.6.2 (2023-06-18)
 ==================

diff --git a/pyproject.toml b/pyproject.toml
@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "Velexi Python Project Cookiecutter"
-version = "0.6.2"
+version = "0.6.3"
 description = "Template for Python projects"
 license = "Apache-2.0"
 authors = ["Kevin Chu <kevin@velexi.com>"]

diff --git a/{{cookiecutter.__project_name}}/.gitignore b/{{cookiecutter.__project_name}}/.gitignore
@@ -1,9 +1,29 @@
-# --- Python files
+# --- Environments
+
+# direnv
+.direnv
+.envrc
+
+# conda
+.conda
+
+# Python virtual environment
+.venv
+
+# --- Python
+
+# pyenv
+.python-version
 
 # compiled code
 __pycache__/
 *.py[cod]
 
+# setuptools
+/dist/
+*.egg-info/
+*.egg*
+
 # testing
 htmlcov/
 .cache
@@ -12,17 +32,11 @@ htmlcov/
 .pytest_cache
 .tox/
 
-# --- Environments
+# pdoc auto-generated documentation
+docs/{{cookiecutter.__project_name}}
 
-# direnv
-.direnv
-.envrc
-
-# conda
-.conda
-
-# common manually-created Python virtual environments
-.venv
+# DotEnv configuration
+.env
 
 # --- Code editors
 

diff --git a/{{cookiecutter.__project_name}}/.pre-commit-config.yaml b/{{cookiecutter.__project_name}}/.pre-commit-config.yaml
@@ -6,11 +6,13 @@ repos:
       entry: black
       language: python
       types: [python]
+      exclude: ^spikes
     - id: flake8
       name: flake8
       entry: flake8
       language: python
       types: [python]
+      exclude: ^spikes
   - repo: https://github.com/pre-commit/pre-commit-hooks
     rev: v2.5.0
     hooks: