Skip to main content

Explore APIs from your console with API Buddy

Project description

API Buddy

Build Status PyPI version

Demo

Right now, only OAuth2 authentication is supported. It's the most common, and current gold standard for security best practices. Also most APIs use it. That said, I have no beef with all the APIs out there using something else, so feel free to open a ticket if you want something else supported. 🎟

You can also always manually set headers.

Installation

As long as you have python 3.7 or higher (I recommend using pyenv), just:

pip install api-buddy

Usage

First, specify the API you're exploring in your preferences

# ~/.api-buddy.yaml
api_url: https://some.api.com

Then it's as easy as:

api get some-endpoint
=> 200
{
  "look": "I haz data",
  "thx": "API Buddy"
}

HTTP Method defaults to get:

api this-endpoint  # same as first example

You can add query params in key=val format:

api get \
  my/favorite/endpoint \
  first_name=cosmo \
  last_name=kramer

You can also add request body data in JSON format:

api post \
  some-endpoint \
  '{"id": 1, "field": "value"}'

🤔 Note the single-quotes. You can expand this accross multiple lines:

api post \
  some-endpoint \
  '{
     "id": 1,
     "field": "value"
  }'

Preferences 👉

Arguments

  • http_method: (optional, default=get) The HTTP method to use in your request.
    • It should be one of:
      • get
      • post
      • patch
      • put
      • delete
  • endpoint: (required) The relative path to an API endpoint.
    • AKA you don't need to type the base api url again here.
  • params: (optional) A list of key=val query params
  • data: (optional) A JSON string of requets body data.
    • You can't use this with get because HTTP.

Options

  • -h, --help: Show the help message
  • -v, --version: Show the installed version

Development

Requires:

Steps to start working:

  • Build and create the local venv with bin/setup
  • Make sure everything works with bin/test
  • Try the local cli with poetry run api --help
  • Find other management commands with bin/list

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

api-buddy-0.4.0.tar.gz (18.7 kB view details)

Uploaded Source

Built Distribution

api_buddy-0.4.0-py3-none-any.whl (23.7 kB view details)

Uploaded Python 3

File details

Details for the file api-buddy-0.4.0.tar.gz.

File metadata

  • Download URL: api-buddy-0.4.0.tar.gz
  • Upload date:
  • Size: 18.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/0.12.17 CPython/3.7.2 Darwin/18.7.0

File hashes

Hashes for api-buddy-0.4.0.tar.gz
Algorithm Hash digest
SHA256 56f80d90114002439a2763f12a24ed2011d5255bdf4921c3a6cfe52aeb2af736
MD5 33fc7bd877fb6ecbcff0b87593acd459
BLAKE2b-256 7865b166d7d0c00234b94338d7d650dbda614fa43a250e321d310dfeae5cbb8a

See more details on using hashes here.

File details

Details for the file api_buddy-0.4.0-py3-none-any.whl.

File metadata

  • Download URL: api_buddy-0.4.0-py3-none-any.whl
  • Upload date:
  • Size: 23.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/0.12.17 CPython/3.7.2 Darwin/18.7.0

File hashes

Hashes for api_buddy-0.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 85cb30dee4ecbef3b90416b78bbd44b8c3d58f0025522090de938837061c7d84
MD5 d9dd21fc85d5a452a628208b3174916c
BLAKE2b-256 c19572043dbcf3a0f4158c3b507dd64343c570c5ba6e1723b774cb0771ff6bd3

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