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

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+
virtualenvwrapper_

Getting Help with Make Tasks

Execute the following command to get a full list of make targets::

$ make help

Setup Python Development Environment

Create a Python virtual environment::

$ mkvirtualenv -p py310 pytest-flask-ligand
Setup develop environment::

$ make develop-venv
Setup git pre-commit hooks::

$ make setup-pre-commit
Verify that environment is ready for development::

$ make test-all

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.

Python Black IDE Integration

This repo utilizes Python Black_ for automatic code formatting using the make format task. 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 .. _virtualenvwrapper: https://virtualenvwrapper.readthedocs.io/en/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