Skip to main content

Bearer Agent

Project description

Bearer Agent

Build Status

Observe, control and receive alerts on your third-party APIs by adding the Bearer agent to your Python application.

Documentation

The documentation is hosted at https://python.docs.bearer.sh/

Installation

The Bearer agent requires Python 3.x >= 3.5.

Install from PyPI:

$ pip install bearer-agent

Then set up the Bearer agent with your Secret Key (available on the Bearer dashboard):

import bearer_agent

bearer_agent.init(secret_key="YOUR_BEARER_SECRET_KEY")

Keeping your data protected

We recommend you sanitize your data before sending it to the Bearer dashboard. We think it's best to setup the sanitization level that best suits your needs. An example using the default values is as follows:

bearer_agent.init(
    strip_sensitive_data=True,
    strip_sensitive_keys=(
        "^authorization$|"
        "^password$|"
        "^secret$|"
        "^passwd$|"
        "^api.?key$|"
        "^access.?token$|"
        "^auth.?token$|"
        "^credentials$|"
        "^mysql_pwd$|"
        "^stripetoken$|"
        "^card.?number.?$|"
        "^secret$|"
        "^client.?id$|"
        "^client.?secret$"
    ),
    strip_sensitive_regex=(
        r"[a-zA-Z0-9]{1}[a-zA-Z0-9.!#$%&’*+=?^_`{|}~-]+@[a-zA-Z0-9-]+(?:\.[a-zA-Z0-9-]+)*|"
        r"(?:\d[ -]*?){13,16}"
    )
)

Compatibility matrix

Python3 :

On Python 3.x (>= 3.5) bearer support the following:

On Python 2.7, bearer support the following client Library or application based on:

Development

Running tests

To run a format check (black), the linter (flake8) and tests (pytest):

$ tox

To only run the tests:

$ tox -e py37

Git hooks

There are Git hooks to format the code and run the linter when committing.

Install https://pre-commit.com/ and then run:

$ pre-commit install

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

bearer-agent-1.1.2.tar.gz (54.6 kB view details)

Uploaded Source

Built Distribution

bearer_agent-1.1.2-py3-none-any.whl (83.5 kB view details)

Uploaded Python 3

File details

Details for the file bearer-agent-1.1.2.tar.gz.

File metadata

  • Download URL: bearer-agent-1.1.2.tar.gz
  • Upload date:
  • Size: 54.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/52.0.0 requests-toolbelt/0.9.1 tqdm/4.56.0 CPython/3.8.7

File hashes

Hashes for bearer-agent-1.1.2.tar.gz
Algorithm Hash digest
SHA256 f838ed4d05e16f890f605f653cd338406701f18b180d60b8575a6bf9699ffee8
MD5 02a49c1d15dd87ee1a529cdfecc95967
BLAKE2b-256 6eb0b6c7398abc01ff23384accada698e9ab4fa2674eda7ba519799b2eb6eb82

See more details on using hashes here.

File details

Details for the file bearer_agent-1.1.2-py3-none-any.whl.

File metadata

  • Download URL: bearer_agent-1.1.2-py3-none-any.whl
  • Upload date:
  • Size: 83.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/52.0.0 requests-toolbelt/0.9.1 tqdm/4.56.0 CPython/3.8.7

File hashes

Hashes for bearer_agent-1.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 8688250162d3baf47439dc07aef4877ea197c45d305fdb68c9d3b0b1f1a485df
MD5 c926f21f0f341bdc6e7c9d824184134e
BLAKE2b-256 c12001dac65b8221aa1b406dc564d18c25a8eef42572ace864af05c1b2025579

See more details on using hashes here.

Supported by

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