Skip to main content

An API client for simplifying API testing with Python + PyTest

Project description

🔥 berAPI 🔥

An API client for simplifying API testing with Python + PyTest

Project Link

Features

  • Builtin curl API in the pytest-html report
  • Easy to import the API logs into Postman/curl
  • Multiple common assertions to a single request

Report

Installation

pip3 install berapi

How to use

Create an instance of berAPI class, and you can build API test request and assertion chain of the response

from berapi.apy import berAPI

def test_simple():
    url = 'https://swapi.dev/api/people/1'
    api = berAPI()
    response = api.get(url).assert_2xx().parse_json()
    assert response['name'] == 'Luke Skywalker'

def test_chaining():
    (berAPI()
     .get('https://swapi.dev/api/people/1')
     .assert_2xx()
     .assert_value('name', 'Luke Skywalker')
     .assert_response_time_less_than(seconds=1)
     )

Configuration

env variable used in berapi

export MAX_RESPONSE_TIME=5
export MAX_TIMEOUT=3

To have robust response log make sure you enable settings in pytest.ini

[pytest]
log_cli_level = INFO

Install Development

pip install poetry
poetry install --with test

Run Test

poetry run pytest tests

Building Lib

poetry build
poetry publish

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

berapi-0.1.5.tar.gz (4.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

berapi-0.1.5-py3-none-any.whl (4.9 kB view details)

Uploaded Python 3

File details

Details for the file berapi-0.1.5.tar.gz.

File metadata

  • Download URL: berapi-0.1.5.tar.gz
  • Upload date:
  • Size: 4.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.4 CPython/3.13.2 Darwin/24.3.0

File hashes

Hashes for berapi-0.1.5.tar.gz
Algorithm Hash digest
SHA256 6701fc286626f8a1cfa8f7560269e7be03a8caecc7485a86ac38b6c613877840
MD5 a0baa372374a299bbdc7da0b0684ab71
BLAKE2b-256 f8a8703839457210a15e1f9655d38617895d8746af829ff5a574f0688a1dbec0

See more details on using hashes here.

File details

Details for the file berapi-0.1.5-py3-none-any.whl.

File metadata

  • Download URL: berapi-0.1.5-py3-none-any.whl
  • Upload date:
  • Size: 4.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.4 CPython/3.13.2 Darwin/24.3.0

File hashes

Hashes for berapi-0.1.5-py3-none-any.whl
Algorithm Hash digest
SHA256 1d05b3e53665488f82b6433f729ff6d723ba1e5aba88d7ff8ea9a068e92a536d
MD5 0c6955a267fa99581c1d63b22a49a211
BLAKE2b-256 65ca243095b9eedd0f09c2325304b32022896e43c2a4dca9a2e38471eb9b6833

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page