build: create base cookiecutter template

Author: dzhang32

cookiecutter.json

@@ -0,0 +1,8 @@
+{
+    "project_name": "snake_case_project_name",
+    "author_name": "David Zhang",
+    "version": "0.1.0",
+    "description": "Main goal of the project.",
+    "python_version": "3.13",
+    "year": "2025"
+}

{{cookiecutter.project_name}}/.pre-commit-config.yaml

@@ -0,0 +1,21 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.3.0
+    hooks:
+      - id: end-of-file-fixer
+      - id: trailing-whitespace
+      - id: check-yaml
+      - id: check-added-large-files
+
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.12.10
+    hooks:
+      - id: ruff-check
+        args: [ --fix ]
+      - id: ruff-format
+
+  - repo: https://github.com/pre-commit/mirrors-mypy
+    rev: v1.17.1
+    hooks:
+      - id: mypy
+        additional_dependencies: [types-requests, types-python-dateutil]

{{cookiecutter.project_name}}/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Changelog
+
+## 0.1.0
+
+- Initial release.

{{cookiecutter.project_name}}/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) {{cookiecutter.year}}, David Zhang
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

{{cookiecutter.project_name}}/README.md

@@ -0,0 +1,5 @@
+# {{cookiecutter.project_name}}
+
+{{cookiecutter.description}}
+
+## Installation

{{cookiecutter.project_name}}/pyproject.toml

@@ -0,0 +1,23 @@
+[project]
+name = "{{cookiecutter.project_name}}"
+version = "{{cookiecutter.version}}"
+description = "{{cookiecutter.description}}"
+authors = [
+    { name = "{{cookiecutter.author_name}}" },
+]
+requires-python = ">={{cookiecutter.version}}"
+dependencies = []
+
+[project.optional-dependencies]
+dev = [
+    "pre-commit==4.3.0",
+    "pytest==8.4.1",
+    "pytest-cov==6.0.0",
+]
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[build-system]
+requires = ["pip>=22.0", "setuptools>=61", "wheel"]
+build-backend = "setuptools.build_meta"

{{cookiecutter.project_name}}/src/{{cookiecutter.project_name}}/__init__.py

@@ -0,0 +1,12 @@
+def add_one(x: int) -> int:
+    """
+    Example function that adds one to the input.
+
+    Args:
+        x: The input number.
+
+    Returns:
+        The input number plus one.
+    """
+
+    return x + 1

{{cookiecutter.project_name}}/src/{{cookiecutter.project_name}}/add_one.py

@@ -0,0 +1,8 @@
+from {{cookiecutter.project_name}}.add_one import add_one
+
+
+def test_add_one():
+    """
+    Test that the add_one function works correctly.
+    """
+    assert add_one(31) == 32