/pytest-flask-ligand

Pytest fixtures and helpers for testing microservices based on 'flask-ligand'

Primary LanguagePythonGNU General Public License v3.0GPL-3.0

pytest-flask-ligand

Build PyPI Codecov pre-commit

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

Getting Help with Make Tasks

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

$ make help

Setup Python Development Environment

  1. Create a Python virtual environment:

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

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

    $ make setup-pre-commit
    
  4. 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.