MOCKING REQUESTS FUTURES
Pytest Plugin to Mock Requests Futures
.. start-badges
| |build| |docs| |coverage| |maintainability| |better_code_hub| |tech-debt|
| |release_version| |wheel| |supported_versions| |gh-lic| |commits_since_specific_tag_on_master| |commits_since_latest_github_release|
|
| Code: https://github.com/boromir674/pytest-requests-futures
| Docs: https://pytest-requests-futures.readthedocs.io/en/master/
| PyPI: https://pypi.org/project/pytest-requests-futures/
| CI: https://github.com/boromir674/pytest-requests-futures/actions/
Features
-
pytest_requests_futures python package
a. TODO Document a Great Feature
b. TODO Document another Nice Feature
-
Tested against multiple platforms
and python
versions
Development
Here are some useful notes related to doing development on this project.
-
Test Suite, using pytest
_, located in tests
dir
-
Parallel Execution of Unit Tests, on multiple cpu's
-
Documentation Pages, hosted on readthedocs
server, located in docs
dir
-
Automation, using tox
_, driven by single tox.ini
file
a. Code Coverage measuring
b. Build Command, using the build
_ python package
c. Pypi Deploy Command, supporting upload to both pypi.org
_ and test.pypi.org
_ servers
d. Type Check Command, using mypy
_
e. Lint Check and Apply
commands, using isort
_ and black
_
-
CI Pipeline, running on Github Actions
_, defined in .github/
a. Job Matrix, spanning different platform
's and python version
's
- Platforms:
ubuntu-latest
, macos-latest
- Python Interpreters:
3.6
, 3.7
, 3.8
, 3.9
, 3.10
b. Parallel Job execution, generated from the matrix
, that runs the Test Suite
Prerequisites
You need to have Python
installed.
Quickstart
Using pip
is the approved way for installing pytest_requests_futures
.
.. code-block:: sh
python3 -m pip install pytest_requests_futures
TODO Document a use case
License
|gh-lic|
GNU Affero General Public License v3.0
_
License
- Free software: GNU Affero General Public License v3.0
.. LINKS
.. _tox: https://tox.wiki/en/latest/
.. _pytest: https://docs.pytest.org/en/7.1.x/
.. _build: https://github.com/pypa/build
.. _pypi.org: https://pypi.org/
.. _test.pypi.org: https://test.pypi.org/
.. _mypy: https://mypy.readthedocs.io/en/stable/
.. _isort: https://pycqa.github.io/isort/
.. _black: https://black.readthedocs.io/en/stable/
.. _Github Actions: https://github.com/boromir674/pytest-requests-futures/actions
.. _GNU Affero General Public License v3.0: https://github.com/boromir674/pytest-requests-futures/blob/master/LICENSE
.. BADGE ALIASES
.. Build Status
.. Github Actions: Test Workflow Status for specific branch
.. |build| image:: https://img.shields.io/github/workflow/status/boromir674/pytest-requests-futures/Test%20Python%20Package/master?label=build&logo=github-actions&logoColor=%233392FF
:alt: GitHub Workflow Status (branch)
:target: https://github.com/boromir674/pytest-requests-futures/actions/workflows/test.yaml?query=branch%3Amaster
.. Documentation
.. |docs| image:: https://img.shields.io/readthedocs/pytest-requests-futures/master?logo=readthedocs&logoColor=lightblue
:alt: Read the Docs (version)
:target: https://pytest-requests-futures.readthedocs.io/en/master/
.. Code Coverage
.. |coverage| image:: https://img.shields.io/codecov/c/github/boromir674/pytest-requests-futures/master?logo=codecov
:alt: Codecov
:target: https://app.codecov.io/gh/boromir674/pytest-requests-futures
.. PyPI
.. |release_version| image:: https://img.shields.io/pypi/v/pytest_requests_futures
:alt: Production Version
:target: https://pypi.org/project/pytest-requests-futures/
.. |wheel| image:: https://img.shields.io/pypi/wheel/pytest-requests-futures?color=green&label=wheel
:alt: PyPI - Wheel
:target: https://pypi.org/project/pytest-requests-futures
.. |supported_versions| image:: https://img.shields.io/pypi/pyversions/pytest-requests-futures?color=blue&label=python&logo=python&logoColor=%23ccccff
:alt: Supported Python versions
:target: https://pypi.org/project/pytest-requests-futures
.. Github Releases & Tags
.. |commits_since_specific_tag_on_master| image:: https://img.shields.io/github/commits-since/boromir674/pytest-requests-futures/v0.9.0/master?color=blue&logo=github
:alt: GitHub commits since tagged version (branch)
:target: https://github.com/boromir674/pytest-requests-futures/compare/v0.9.0..master
.. |commits_since_latest_github_release| image:: https://img.shields.io/github/commits-since/boromir674/pytest-requests-futures/latest?color=blue&logo=semver&sort=semver
:alt: GitHub commits since latest release (by SemVer)
.. LICENSE (eg AGPL, MIT)
.. Github License
.. |gh-lic| image:: https://img.shields.io/github/license/boromir674/pytest-requests-futures
:alt: GitHub
:target: https://github.com/boromir674/pytest-requests-futures/blob/master/LICENSE
.. CODE QUALITY
.. Better Code Hub
.. Software Design Patterns
.. |better_code_hub| image:: https://bettercodehub.com/edge/badge/boromir674/pytest-requests-futures?branch=master
:alt: Better Code Hub
:target: https://bettercodehub.com/
.. Code Climate CI
.. Code maintainability & Technical Debt
.. |maintainability| image:: https://img.shields.io/codeclimate/maintainability/boromir674/pytest-requests-futures
:alt: Code Climate Maintainability
:target: https://codeclimate.com/github/boromir674/pytest-requests-futures
.. |tech-debt| image:: https://img.shields.io/codeclimate/tech-debt/boromir674/pytest-requests-futures
:alt: Technical Debt
:target: https://codeclimate.com/github/boromir674/pytest-requests-futures