Initial commit

Author: remarkablemark

.github/CODEOWNERS

@@ -0,0 +1,3 @@
+* @remarkablemark
+
+/pyproject.toml

.github/CONTRIBUTING.md

@@ -0,0 +1,151 @@
+# Contributing
+
+<details>
+<summary>Table of Contents</summary>
+
+- [Fork](#fork)
+- [Install](#install)
+- [Develop](#develop)
+- [Test](#test)
+- [Lint](#lint)
+- [Build](#build)
+- [Release](#release)
+
+</details>
+
+Pull requests are welcome! By participating in this project, you agree to abide by our [code of conduct](https://github.com/remarkablemark/.github/blob/master/CODE_OF_CONDUCT.md).
+
+## Fork
+
+[Fork](https://github.com/remarkablemark/python_package_template/fork) and then clone the repository:
+
+```sh
+# replace <USER> with your username
+git clone [email protected]:<USER>/python_package_template.git
+```
+
+```sh
+cd python_package_template
+```
+
+## Install
+
+Install [Python](https://www.python.org/):
+
+```sh
+brew install python
+```
+
+Create the virtual environment:
+
+```sh
+python3 -m venv .venv
+```
+
+Activate the virtual environment:
+
+```sh
+source .venv/bin/activate
+```
+
+Install the dependencies:
+
+```sh
+pip install -e '.[build]'
+pip install -e '.[test]'
+```
+
+Install pre-commit into your git hooks:
+
+```sh
+pre-commit install
+```
+
+## Develop
+
+Make your changes, add tests/documentation, and ensure tests pass:
+
+```sh
+pytest
+```
+
+Write a commit message that follows the [Conventional Commits](https://www.conventionalcommits.org/) specification:
+
+- **feat**: A new feature
+- **fix**: A bug fix
+- **perf**: A code change that improves performance
+- **refactor**: A code change that neither fixes a bug nor adds a feature
+- **test**: Add missing tests or correct existing tests
+- **build**: Changes that affect the build system or external dependencies
+- **ci**: Updates configuration files and scripts for continuous integration
+- **docs**: Documentation only changes
+
+Push to your fork and create a [pull request](https://github.com/remarkablemark/python_package_template/compare/).
+
+At this point, wait for us to review your pull request. We'll try to review pull requests within 1-3 business days. We may suggest changes, improvements, and/or alternatives.
+
+Things that will improve the chance that your pull request will be accepted:
+
+- [ ] Write tests that pass [CI](https://github.com/remarkablemark/python_package_template/actions/workflows/test.yml).
+- [ ] Write solid documentation.
+- [ ] Write a good [commit message](https://github.com/angular/angular/blob/main/CONTRIBUTING.md#commit).
+
+## Test
+
+Run the tests:
+
+```sh
+pytest
+```
+
+## Lint
+
+Update pre-commit hooks to the latest version:
+
+```sh
+pre-commit autoupdate
+```
+
+Run all pre-commit hooks:
+
+```sh
+pre-commit run --all-files
+```
+
+Lint all files in the current directory:
+
+```sh
+ruff check
+```
+
+Format all files in the current directory:
+
+```sh
+ruff format
+```
+
+## Build
+
+Generate distribution packages:
+
+```sh
+python3 -m build
+```
+
+Upload all of the archives under `dist`:
+
+```sh
+twine upload --repository testpypi dist/*
+```
+
+Install the package:
+
+```sh
+pip install --index-url https://test.pypi.org/simple/ --no-deps python_package_template
+```
+
+## Release
+
+Release and publish are automated with [Release Please](https://github.com/googleapis/release-please).
+
+[Add a new pending publisher to PyPI.](https://pypi.org/manage/account/publishing/)

.github/dependabot.yml

@@ -0,0 +1,16 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://docs.github.com/code-security/dependabot/working-with-dependabot/dependabot-options-reference
+
+version: 2
+updates:
+  - package-ecosystem: 'pip'
+    directory: '/'
+    schedule:
+      interval: 'daily'
+
+  - package-ecosystem: 'github-actions'
+    directory: '/'
+    schedule:
+      interval: 'daily'

.github/mergify.yml

@@ -0,0 +1,11 @@
+pull_request_rules:
+  - name: automatic merge for Dependabot pull requests
+    conditions:
+      - author=dependabot[bot]
+      - check-success=commitlint
+      - check-success=lint
+      - check-success=test
+      - 'title~=^build\(deps-dev\): bump '
+    actions:
+      merge:
+        method: squash

.github/workflows/commitlint.yml

@@ -0,0 +1,14 @@
+name: commitlint
+on: [push, pull_request]
+
+permissions:
+  contents: read
+
+jobs:
+  commitlint:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Commitlint
+        uses: remarkablemark/commitlint@v1
+        with:
+          checkout: true

.github/workflows/lint.yml

@@ -0,0 +1,30 @@
+name: lint
+on: [push, pull_request]
+
+permissions:
+  contents: read
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Use Python
+        uses: actions/setup-python@v5
+        with:
+          cache: pip
+          python-version: 3
+
+      - name: Install dependencies
+        run: pip install -e .[test]
+
+      - name: Run Black
+        run: black --check .
+
+      - name: Run Ruff
+        run: ruff check
+
+      - name: Run pre-commit
+        run: pre-commit run --all-files

.github/workflows/release-please.yml

@@ -0,0 +1,51 @@
+name: release-please
+on:
+  push:
+    branches:
+      - master
+
+jobs:
+  release-please:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      pull-requests: write
+    outputs:
+      release_created: ${{ steps.release.outputs.release_created }}
+
+    steps:
+      - name: Release Please
+        uses: googleapis/release-please-action@v4
+        id: release
+        with:
+          release-type: python
+
+  publish:
+    runs-on: ubuntu-latest
+    needs: release-please
+    if: ${{ needs.release-please.outputs.release_created }}
+    permissions:
+      contents: read
+      id-token: write
+    environment:
+      name: pypi
+      url: https://pypi.org/p/python_package_template
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Use Python
+        uses: actions/setup-python@v5
+        with:
+          cache: pip
+          python-version: 3
+
+      - name: Install dependencies
+        run: python -m pip install build
+
+      - name: Build package
+        run: python -m build
+
+      - name: Publish package to PyPI
+        uses: pypa/gh-action-pypi-publish@v1

.github/workflows/test.yml

@@ -0,0 +1,24 @@
+name: test
+on: [push, pull_request]
+
+permissions:
+  contents: read
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Use Python
+        uses: actions/setup-python@v5
+        with:
+          cache: pip
+          python-version: 3
+
+      - name: Install dependencies
+        run: pip install -e .[test]
+
+      - name: Run pytest
+        run: pytest