pytest-databases 0.2.0__tar.gz → 0.2.2__tar.gz

pytest_databases-0.2.2/.pre-commit-config.yaml

@@ -0,0 +1,31 @@
+exclude: "^docs/conf.py"
+
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.5.0
+    hooks:
+      - id: trailing-whitespace
+      - id: check-added-large-files
+      - id: check-ast
+      - id: check-json
+      - id: check-merge-conflict
+      - id: check-xml
+      - id: check-yaml
+        args: ["--unsafe"] # needed for !! tags in mkdocs.yml
+      - id: debug-statements
+      - id: end-of-file-fixer
+      - id: mixed-line-ending
+        args: ["--fix=auto"] # replace 'auto' with 'lf' to enforce Linux/Mac line endings or 'crlf' for Windows
+
+  # Ruff replaces black, flake8, autoflake and isort
+  - repo: https://github.com/charliermarsh/ruff-pre-commit
+    rev: "v0.3.5" # make sure this is always consistent with hatch configs
+    hooks:
+      - id: ruff
+        args: [--config, ./pyproject.toml]
+
+  - repo: https://github.com/pre-commit/mirrors-prettier
+    rev: v4.0.0-alpha.8
+    hooks:
+      - id: prettier
+        exclude: templates|migrations|scripts|docs|dist|.venv|public

pytest_databases-0.2.2/.sourcery.yaml

@@ -0,0 +1,42 @@
+ignore:
+  - .tox/
+  - .venv/
+  - dist/
+  - docs/_build/
+  - docs/_static/
+  - node_modules/
+  - vendor/
+  - venv/
+
+rule_settings:
+  enable: [default]
+  disable: [dont-import-test-modules]
+  rule_types:
+    - refactoring
+    - suggestion
+    - comment
+  python_version: "3.8"
+
+rules: []
+
+metrics:
+  quality_threshold: 25.0
+
+github:
+  ignore_labels:
+    - sourcery-ignore
+    - docs
+  labels:
+    - build-ignore
+  request_review:
+    origin: owner
+    forked: author
+  sourcery_branch: sourcery/{base_branch}
+
+clone_detection:
+  min_lines: 3
+  min_duplicates: 2
+  identical_clones_only: false
+
+proxy:
+  no_ssl_verify: false

pytest_databases-0.2.2/.vscode/settings.json

@@ -0,0 +1,96 @@
+{
+  "files.exclude": {
+    "**/._*": true,
+    "**/*.pyc": {
+      "when": "$(basename).py"
+    },
+    ".coverage.*": true,
+    ".mypy_cache": true,
+    "**/__pycache__": true,
+    ".venv": true,
+    ".direnv": true,
+    ".idea": true,
+    ".run": true,
+    ".pytest_cache": true,
+    ".cache": true,
+    ".dist": true,
+    "**/.pytest_cache": true,
+    "site": true,
+    ".angular": true,
+    ".ruff_cache": true,
+    ".astro": true,
+    ".unasyncd_cache": true,
+    ".coverage": true,
+    "node_modules": true,
+    ".terraform": true
+  },
+  "ruff.format.args": ["--config=${workspaceFolder}/pyproject.toml"],
+  "ruff.lint.run": "onType",
+  "ruff.lint.args": ["--config=${workspaceFolder}/pyproject.toml"],
+  "mypy-type-checker.importStrategy": "fromEnvironment",
+  "pylint.importStrategy": "fromEnvironment",
+  "python.autoComplete.extraPaths": ["${workspaceFolder}/src"],
+  "python.terminal.activateEnvInCurrentTerminal": true,
+  "python.terminal.executeInFileDir": true,
+  "python.testing.pytestEnabled": true,
+  "autoDocstring.guessTypes": false,
+  "python.analysis.autoImportCompletions": true,
+  "python.analysis.autoFormatStrings": true,
+  "python.analysis.extraPaths": ["${workspaceFolder}/src"],
+  "editor.formatOnSave": true,
+  "notebook.formatOnSave.enabled": true,
+  "black-formatter.args": ["--line-length=120"],
+  "evenBetterToml.formatter.reorderKeys": true,
+  "evenBetterToml.formatter.trailingNewline": true,
+  "evenBetterToml.formatter.columnWidth": 120,
+  "evenBetterToml.formatter.arrayAutoCollapse": true,
+  "python.globalModuleInstallation": false,
+  "python.testing.unittestEnabled": false,
+  "editor.codeActionsOnSave": {
+    "source.fixAll.ruff": "explicit",
+    "source.organizeImports.ruff": "explicit"
+  },
+  "[python]": {
+    "editor.formatOnSave": true,
+    "editor.formatOnSaveMode": "file",
+    "editor.insertSpaces": true,
+    "editor.tabSize": 4,
+    "editor.trimAutoWhitespace": true,
+    "editor.defaultFormatter": "charliermarsh.ruff",
+    "editor.codeActionsOnSave": {
+      "source.fixAll": "explicit",
+      "source.organizeImports": "explicit"
+    }
+  },
+  "python.analysis.fixAll": [
+    "source.unusedImports",
+    "source.convertImportFormat"
+  ],
+  "sqltools.disableReleaseNotifications": true,
+  "sqltools.disableNodeDetectNotifications": true,
+  "cloudcode.duetAI.enable": true,
+  "cloudcode.compute.sshInternalIp": true,
+  "python.testing.pytestArgs": ["tests"],
+  "markdownlint.run": "onSave",
+  "markdownlint.config": {
+    "default": true,
+    "MD046": {
+      "style": "fenced"
+    },
+    "MD007": {
+      "indent": 4
+    },
+    "no-hard-tabs": false
+  },
+  "yaml.schemas": {
+    "https://squidfunk.github.io/mkdocs-material/schema.json": "mkdocs.yml"
+  },
+  "yaml.customTags": [
+    "!ENV scalar",
+    "!ENV sequence",
+    "!relative scalar",
+    "tag:yaml.org,2002:python/name:material.extensions.emoji.to_svg",
+    "tag:yaml.org,2002:python/name:material.extensions.emoji.twemoji",
+    "tag:yaml.org,2002:python/name:pymdownx.superfences.fence_code_format"
+  ]
+}

pytest_databases-0.2.2/CODEOWNERS

@@ -0,0 +1,7 @@
+# Code owner settings for `litestar-org`
+# @maintainers should be assigned to all reviews.
+# Most specific assignment takes precedence though, so if you add a more specific thing than the `*` glob, you must also add @maintainers
+# For more info about code owners see https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners#codeowners-file-example
+
+# Global Assignment
+*      @litestar-org/maintainers @litestar-org/members

pytest_databases-0.2.2/CONTRIBUTING.rst

@@ -0,0 +1,80 @@
+Contribution guide
+==================
+
+Setting up the environment
+--------------------------
+
+1. Install `PDM <https://pdm.fming.dev/latest/>`_
+2. Run ``pdm install -G:all`` to create a `virtual environment <https://docs.python.org/3/tutorial/venv.html>`_ and install
+   the dependencies
+3. If you're working on the documentation and need to build it locally, install the extra dependencies with ``pdm install -G:docs``
+4. Install `pre-commit <https://pre-commit.com/>`_
+5. Run ``pre-commit install`` to install pre-commit hooks
+
+Code contributions
+------------------
+
+Workflow
+++++++++
+
+1. `Fork <https://github.com/litestar-org/pytest-databases/fork>`_ the `Pytest Database Alchemy repository <https://github.com/litestar-org/pytest-databases>`_
+2. Clone your fork locally with git
+3. `Set up the environment <#setting-up-the-environment>`_
+4. Make your changes
+5. (Optional) Run ``pre-commit run --all-files`` to run linters and formatters. This step is optional and will be executed
+   automatically by git before you make a commit, but you may want to run it manually in order to apply fixes
+6. Commit your changes to git
+7. Push the changes to your fork
+8. Open a `pull request <https://docs.github.com/en/pull-requests>`_. Give the pull request a descriptive title
+   indicating what it changes. If it has a corresponding open issue, the issue number should be included in the title as
+   well. For example a pull request that fixes issue ``bug: Increased stack size making it impossible to find needle #100``
+   could be titled ``fix(#100): Make needles easier to find by applying fire to haystack``
+
+.. tip:: Pull requests and commits all need to follow the
+    `Conventional Commit format <https://www.conventionalcommits.org>`_
+
+.. note:: To run the integration tests locally, you will need the `ODBC Driver for SQL Server <https://learn.microsoft.com/en-us/sql/connect/odbc/download-odbc-driver-for-sql-server?view=sql-server-ver16>`_, one option is using `unixODBC <https://www.unixodbc.org/>`_.
+
+Guidelines for writing code
+----------------------------
+
+- All code should be fully `typed <https://peps.python.org/pep-0484/>`_. This is enforced via
+  `mypy <https://mypy.readthedocs.io/en/stable/>`_.
+- All code should be tested. This is enforced via `pytest <https://docs.pytest.org/en/stable/>`_.
+- All code should be properly formatted. This is enforced via `black <https://black.readthedocs.io/en/stable/>`_ and `Ruff <https://beta.ruff.rs/docs/>`_.
+
+Writing and running tests
++++++++++++++++++++++++++
+
+.. todo:: Write this section
+
+Project documentation
+---------------------
+
+The documentation is located in the ``/docs`` directory and is `ReST <https://docutils.sourceforge.io/rst.html>`_ and
+`Sphinx <https://www.sphinx-doc.org/en/master/>`_. If you're unfamiliar with any of those,
+`ReStructuredText primer <https://www.sphinx-doc.org/en/master/lib/usage/restructuredtext/basics.html>`_ and
+`Sphinx quickstart <https://www.sphinx-doc.org/en/master/lib/usage/quickstart.html>`_ are recommended reads.
+
+Running the docs locally
+++++++++++++++++++++++++
+
+To run or build the docs locally, you need to first install the required dependencies:
+
+``pdm install -G:docs``
+
+Then you can serve the documentation with ``make docs-serve``, or build them with ``make docs``.
+
+Creating a new release
+----------------------
+
+1. Increment the version in `pyproject.toml <https://github.com/litestar-org/pytest-databases/blob/main/pyproject.toml>`_.
+    .. note:: The version should follow `semantic versioning <https://semver.org/>`_ and `PEP 440 <https://www.python.org/dev/peps/pep-0440/>`_.
+2. `Draft a new release <https://github.com/litestar-org/pytest-databases/releases/new>`_ on GitHub
+
+   * Use ``vMAJOR.MINOR.PATCH`` (e.g. ``v1.2.3``) as both the tag and release title
+   * Fill in the release description. You can use the "Generate release notes" function to get a draft for this
+3. Commit your changes and push to ``main``
+4. Publish the release
+5. Go to `Actions <https://github.com/litestar-org/pytest-databases/actions>`_ and approve the release workflow
+6. Check that the workflow runs successfully

pytest_databases-0.2.2/Makefile

@@ -0,0 +1,116 @@
+.DEFAULT_GOAL:=help
+.ONESHELL:
+ENV_PREFIX		        =.venv/bin/
+VENV_EXISTS           =	$(shell python3 -c "if __import__('pathlib').Path('.venv/bin/activate').exists(): print('yes')")
+BUILD_DIR             =dist
+SRC_DIR               =src
+BASE_DIR              =$(shell pwd)
+
+.EXPORT_ALL_VARIABLES:
+
+ifndef VERBOSE
+.SILENT:
+endif
+
+
+help:  ## Display this help
+	@awk 'BEGIN {FS = ":.*##"; printf "\nUsage:\n  make \033[36m<target>\033[0m\n"} /^[a-zA-Z0-9_-]+:.*?##/ { printf "  \033[36m%-15s\033[0m %s\n", $$1, $$2 } /^##@/ { printf "\n\033[1m%s\033[0m\n", substr($$0, 5) } ' $(MAKEFILE_LIST)
+
+
+# =============================================================================
+# Developer Utils
+# =============================================================================
+install-pipx: 										## Install pipx
+	@python3 -m pip install --upgrade --user pipx
+
+install-hatch: 										## Install Hatch, UV, and Ruff
+	@pipx install hatch --force
+	@pipx inject hatch ruff uv hatch-pip-compile hatch-vcs hatch-mypyc mypy --include-deps --include-apps --force
+
+configure-hatch: 										## Configure Hatch defaults
+	@hatch config set dirs.env.virtual .direnv
+	@hatch config set dirs.env.pip-compile .direnv
+
+upgrade-hatch: 										## Update Hatch, UV, and Ruff
+	@pipx upgrade hatch --include-injected
+
+install: 										## Install the project and all dependencies
+	@if [ "$(VENV_EXISTS)" ]; then echo "=> Removing existing virtual environment"; $(MAKE) destroy-venv; fi
+	@$(MAKE) clean
+	@if ! pipx --version > /dev/null; then echo '=> Installing `pipx`'; $(MAKE) install-pipx ; fi
+	@if ! hatch --version > /dev/null; then echo '=> Installing `hatch` with `pipx`'; $(MAKE) install-hatch ; fi
+	@if ! hatch-pip-compile --version > /dev/null; then echo '=> Updating `hatch` and installing plugins'; $(MAKE) upgrade-hatch ; fi
+	@echo "=> Creating Python environments..."
+	@$(MAKE) configure-hatch
+	@hatch env create local
+	@echo "=> Install complete! Note: If you want to re-install re-run 'make install'"
+
+
+.PHONY: upgrade
+upgrade:       										## Upgrade all dependencies to the latest stable versions
+	@echo "=> Updating all dependencies"
+	@hatch-pip-compile --upgrade --all
+	@echo "=> Python Dependencies Updated"
+	@hatch run lint:pre-commit autoupdate
+	@echo "=> Updated Pre-commit"
+
+
+.PHONY: clean
+clean: 														## remove all build, testing, and static documentation files
+	@echo "=> Cleaning working directory"
+	@rm -rf .pytest_cache .ruff_cache .hypothesis build/ dist/ .eggs/ .coverage coverage.xml coverage.json htmlcov/ .mypy_cache
+	@find . -name '*.egg-info' -exec rm -rf {} +
+	@find . -name '*.egg' -exec rm -f {} +
+	@find . -name '*.pyc' -exec rm -f {} +
+	@find . -name '*.pyo' -exec rm -f {} +
+	@find . -name '*~' -exec rm -f {} +
+	@find . -name '__pycache__' -exec rm -rf {} +
+	@find . -name '.pytest_cache' -exec rm -rf {} +
+	@find . -name '.ipynb_checkpoints' -exec rm -rf {} +
+	@echo "=> Source cleaned successfully"
+
+deep-clean: clean destroy-venv							## Clean everything up
+	@hatch python remove all
+	@echo "=> Hatch environments pruned and python installations trimmed"
+	@uv cache clean
+	@echo "=> UV Cache cleaned successfully"
+
+destroy-venv: 											## Destroy the virtual environment
+	@hatch env prune
+	@hatch env remove lint
+	@rm -Rf .venv
+	@rm -Rf .direnv
+
+.PHONY: build
+build: clean        ## Build and package the collectors
+	@echo "=> Building package..."
+	@hatch build
+	@echo "=> Package build complete..."
+
+
+###############
+# docs        #
+###############
+.PHONY: serve-docs
+serve-docs:       ## Serve HTML documentation
+	@hatch run docs:serve
+
+.PHONY: docs
+docs:       ## generate HTML documentation and serve it to the browser
+	@hatch run docs:build
+
+
+# =============================================================================
+# Tests, Linting, Coverage
+# =============================================================================
+.PHONY: lint
+lint: 												## Runs pre-commit hooks; includes ruff linting, codespell, black
+	@echo "=> Running pre-commit process"
+	@hatch run lint:fix
+	@echo "=> Pre-commit complete"
+
+.PHONY: test
+test:  												## Run the tests
+	@echo "=> Running test cases"
+	@hatch run test:cov
+	@echo "=> Tests complete"

{pytest_databases-0.2.0 → pytest_databases-0.2.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pytest-databases
-Version: 0.2.0
+Version: 0.2.2
 Summary: Reusable database fixtures for any and all databases.
 Project-URL: Documentation, https://github.com/litestar-org/pytest-databases#readme
 Project-URL: Issues, https://github.com/litestar-org/pytest-databases/issues
@@ -22,6 +22,10 @@ Requires-Python: >=3.8
 Requires-Dist: pytest
 Provides-Extra: cockroachdb
 Requires-Dist: psycopg; extra == 'cockroachdb'
+Provides-Extra: dragonfly
+Requires-Dist: redis; extra == 'dragonfly'
+Provides-Extra: keydb
+Requires-Dist: redis; extra == 'keydb'
 Provides-Extra: mssql
 Requires-Dist: aioodbc; extra == 'mssql'
 Provides-Extra: mysql

{pytest_databases-0.2.0 → pytest_databases-0.2.2}/pyproject.toml

@@ -12,7 +12,7 @@ license = "MIT"
 name = "pytest-databases"
 readme = "README.md"
 requires-python = ">=3.8"
-version = "0.2.0"
+version = "0.2.2"
 #
 authors = [{ name = "Cody Fincher", email = "cody.fincher@gmail.com" }]
 keywords = [
@@ -50,6 +50,8 @@ Source = "https://github.com/litestar-org/pytest-databases"
 
 [project.optional-dependencies]
 cockroachdb = ["psycopg"]
+dragonfly = ["redis"]
+keydb = ["redis"]
 mssql = ["aioodbc"]
 mysql = ["asyncmy>=0.2.9"]
 oracle = ["oracledb"]
@@ -61,85 +63,8 @@ sqlite = ["aiosqlite"]
 ######################
 # Build & Versioning #
 ######################
-[tool.hatch.metadata]
-# direct dependency references, e.g `pip @ git+https://github.com/pypa/pip.git@master`
-allow-direct-references = true
-
-[tool.hatch.build]
-dev-mode-dirs = ["src/"]
-include = ["src/pytest_databases/**/*.yml"]
-packages = ["src/pytest_databases"]
-sources = ["src"]
-
 [tool.hatch.build.targets.sdist]
-exclude = [".github", "./docs"]
-support-legacy = true           # Create setup.py
-
-[tool.hatch.build.targets.wheel]
-packages = ["src/pytest_databases"]
-
-[tool.git-cliff.changelog]
-body = """
-{% if version %}\
-    `Release [v{{ version | trim_start_matches(pat="v") }}] - {{ timestamp | date(format="%Y-%m-%d") }} <https://github.com/litestar-org/pytest-databases/releases/tag/v{{ version | trim_start_matches(pat="v") }}>`_
-    ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
-    * `See All commits in v{{ version | trim_start_matches(pat="v") }} <https://github.com/litestar-org/pytest-databases/commits/v{{ version | trim_start_matches(pat="v") }}>`_
-{% else %}\
-    [unreleased]
-    ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
-{% endif %}\
-{% if previous %}\
-    {% if previous.commit_id %}
-        `{{ previous.commit_id | truncate(length=7, end="") }} <https://github.com/litestar-org/pytest-databases/commit/{{ previous.commit_id }}>`_ ... \
-            `{{ commit_id | truncate(length=7, end="") }} <https://github.com/litestar-org/pytest-databases/commit/{{ commit_id }}>`_ \
-            | `See diff for {{ version | trim_start_matches(pat="v") }} <https://github.com/litestar-org/pytest-databases/compare/{{ previous.commit_id }}...{{ commit_id }}>`_
-    {% endif %}\
-{% endif %}\
-{% for group, commits in commits | group_by(attribute="group") %}
-    {{ group | upper_first }}
-    ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-    {% for commit in commits %}
-        * (`{{ commit.id | truncate(length=7, end="") }} <https://github.com/litestar-org/pytest-databases/commit/{{ commit.id }}>`_) {% if commit.breaking %}[**breaking**] {% endif %} - {{ commit.message | upper_first }} ({{ commit.author.name  }})\
-          {% for footer in commit.footers -%}
-            , {{ footer.token }}{{ footer.separator }}{{ footer.value }}\
-          {% endfor %}\
-    {% endfor %}
-{% endfor %}\n
-"""
-footer = """
-Pytest Databases Changelog
-"""
-header = """
-=========
-Changelog
-=========\n
-All commits to this project will be documented in this file.\n
-"""
-trim = true
-
-[tool.git-cliff.git]
-commit_parsers = [
-  { message = "^feat", group = "Features" },
-  { message = "^fix", group = "Bug Fixes" },
-  { message = "^doc", group = "Documentation" },
-  { message = "^perf", group = "Performance" },
-  { message = "^refactor", group = "Refactor" },
-  { message = "^style", group = "Styling" },
-  { message = "^test", group = "Testing" },
-  { message = "^chore\\(release\\): prepare for", skip = true },
-  { message = "^chore", group = "Miscellaneous Tasks" },
-  { body = ".*security", group = "Security" },
-]
-conventional_commits = true
-filter_commits = false
-filter_unconventional = true
-ignore_tags = ""
-protect_breaking_commits = false
-skip_tags = "v0.1.0-beta.1"
-sort_commits = "oldest"
-split_commits = false
-tag_pattern = "v[0-9]*"
-topo_order = false
+exclude = ["/.github", "/docs"]
 
 
 #####################
@@ -345,6 +270,70 @@ skip = 'pdm.lock, package-lock.json'
 exclude = ["scripts", "docs"]
 include = ["src/pytest_databases", "tests"]
 
+
+[tool.git-cliff.changelog]
+body = """
+{% if version %}\
+    `Release [v{{ version | trim_start_matches(pat="v") }}] - {{ timestamp | date(format="%Y-%m-%d") }} <https://github.com/litestar-org/pytest-databases/releases/tag/v{{ version | trim_start_matches(pat="v") }}>`_
+    ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+    * `See All commits in v{{ version | trim_start_matches(pat="v") }} <https://github.com/litestar-org/pytest-databases/commits/v{{ version | trim_start_matches(pat="v") }}>`_
+{% else %}\
+    [unreleased]
+    ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+{% endif %}\
+{% if previous %}\
+    {% if previous.commit_id %}
+        `{{ previous.commit_id | truncate(length=7, end="") }} <https://github.com/litestar-org/pytest-databases/commit/{{ previous.commit_id }}>`_ ... \
+            `{{ commit_id | truncate(length=7, end="") }} <https://github.com/litestar-org/pytest-databases/commit/{{ commit_id }}>`_ \
+            | `See diff for {{ version | trim_start_matches(pat="v") }} <https://github.com/litestar-org/pytest-databases/compare/{{ previous.commit_id }}...{{ commit_id }}>`_
+    {% endif %}\
+{% endif %}\
+{% for group, commits in commits | group_by(attribute="group") %}
+    {{ group | upper_first }}
+    ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+    {% for commit in commits %}
+        * (`{{ commit.id | truncate(length=7, end="") }} <https://github.com/litestar-org/pytest-databases/commit/{{ commit.id }}>`_) {% if commit.breaking %}[**breaking**] {% endif %} - {{ commit.message | upper_first }} ({{ commit.author.name  }})\
+          {% for footer in commit.footers -%}
+            , {{ footer.token }}{{ footer.separator }}{{ footer.value }}\
+          {% endfor %}\
+    {% endfor %}
+{% endfor %}\n
+"""
+footer = """
+Pytest Databases Changelog
+"""
+header = """
+=========
+Changelog
+=========\n
+All commits to this project will be documented in this file.\n
+"""
+trim = true
+
+[tool.git-cliff.git]
+commit_parsers = [
+  { message = "^feat", group = "Features" },
+  { message = "^fix", group = "Bug Fixes" },
+  { message = "^doc", group = "Documentation" },
+  { message = "^perf", group = "Performance" },
+  { message = "^refactor", group = "Refactor" },
+  { message = "^style", group = "Styling" },
+  { message = "^test", group = "Testing" },
+  { message = "^chore\\(release\\): prepare for", skip = true },
+  { message = "^chore", group = "Miscellaneous Tasks" },
+  { body = ".*security", group = "Security" },
+]
+conventional_commits = true
+filter_commits = false
+filter_unconventional = true
+ignore_tags = ""
+protect_breaking_commits = false
+skip_tags = "v0.1.0-beta.1"
+sort_commits = "oldest"
+split_commits = false
+tag_pattern = "v[0-9]*"
+topo_order = false
+
 [tool.mypy]
 disallow_untyped_defs = false
 files = ["src/pytest_databases", "tests"]