Metadata-Version: 2.4
Name: pytest-flask-ligand
Version: 0.3.0
Project-URL: Changelog, https://github.com/cowofevil/pytest-flask-ligand/blob/main/CHANGELOG.md
Project-URL: Source, https://github.com/cowofevil/pytest-flask-ligand
Project-URL: Tracker, https://github.com/cowofevil/pytest-flask-ligand/issues
Author-email: Ryan Gard <ryan@gardiancapitol.com>
License-Expression: GPL-3.0
License-File: AUTHORS
License-File: LICENSE
Keywords: test,unittest
Classifier: Development Status :: 4 - Beta
Classifier: Framework :: Pytest
Classifier: Intended Audience :: Developers
Classifier: Natural Language :: English
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: POSIX
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: Software Development :: Testing
Classifier: Topic :: Utilities
Classifier: Typing :: Typed
Requires-Python: >=3.10
Requires-Dist: click~=8.1.0
Requires-Dist: flask<4
Requires-Dist: pytest>=7.3
Requires-Dist: python-dateutil==2.8.2
Description-Content-Type: text/x-rst

===================
pytest-flask-ligand
===================

|build-status| |pypi-status| |codecov-status| |pre-commit-status|

Pytest fixtures and helper functions to use for testing flask-ligand microservices.

Developer Quick Start Guide
---------------------------

Follow the instructions below to get a development environment up and running quickly!

Prerequisites
=============

- Python 3.10+
- `Hatch 1.6+`_

Setup Python Development Environment
====================================

1. Navigate to your local git clone of this repository and create a Hatch 'virtualenv' environment for development::

    $ hatch env create

2. Verify development environment is working by running tests::

    $ hatch test

3. Setup git pre-commit hooks::

    $ hatch run setup-pre-commit

4. Prime 'tox' for fast testing::

    $ hatch run test-tox

5. Run tests super fast against all supported Python versions::

    $ hatch run test-tox-fast

6. Enable the Hatch 'virtualenv' development environment::

    $ hatch shell

7. Have fun hacking!

Contributing
------------

See `CONTRIBUTING.rst`_ for more details on developing for the ``pytest-flask-ligand`` project.

Release Process
---------------

See `release_process.rst`_ for information on the release process for the ``pytest-flask-ligand`` project.

Getting Help with Custom Hatch Scripts
======================================

Execute the following command to get a full list of available custom Hatch scripts::

    $ hatch env show

Python Black IDE Integration
----------------------------

This repo utilizes `Python Black`_ for automatic code formatting using the ``hatch fmt`` script. However, this is not
very convenient to use on a regular basis and instead it is recommended to integrate Python Black into your IDE
workflow. Checkout these `editor integration`_ guides for integrating `Python Black`_ with popular IDEs and text
editors.

.. _CONTRIBUTING.rst: CONTRIBUTING.rst
.. _release_process.rst: docs/release_process.rst
.. _Hatch 1.6+: https://hatch.pypa.io/latest/
.. _Python Black: https://black.readthedocs.io/en/stable/
.. _editor integration: https://black.readthedocs.io/en/stable/integrations/editors.html

.. |build-status| image:: https://img.shields.io/github/actions/workflow/status/cowofevil/pytest-flask-ligand/bump_and_publish_release.yml?branch=main&logo=github
   :target: https://github.com/cowofevil/pytest-flask-ligand/actions/workflows/bump_and_publish_release.yml
   :alt: Build
.. |pypi-status| image:: https://img.shields.io/pypi/v/pytest-flask-ligand?color=blue&logo=pypi
   :target: https://pypi.org/project/pytest-flask-ligand/
   :alt: PyPI
.. |codecov-status| image:: https://img.shields.io/codecov/c/gh/cowofevil/pytest-flask-ligand?color=teal&logo=codecov
   :target: https://app.codecov.io/gh/cowofevil/pytest-flask-ligand
   :alt: Codecov
.. |pre-commit-status| image:: https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white
   :target: https://github.com/pre-commit/pre-commit
   :alt: pre-commit
