Skip to main content

The most pleasant HTTP API CLI tool

Project description

API Buddy

Build Status PyPI version

demo

Demo

demo

The most pleasant HTTP API CLI tool

  • Quick to set up
  • Easy to use
  • Automated OAuth2 sign-in
  • Copy/paste-able results

Installation

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

pip install api-buddy

Usage

First, specify the API you're exploring

api use https://some.api.com

Which will set the api_url value in your preferences file

# ~/.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"
}

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, which keeps your json as a sing continuous string. This means you can expand across multiple lines too:

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

Variables can be interpolated within your endpoint, as part of values in your query params, or anywhere in your request body data, as long as they're defined by name in your preferences:

api post \
  'users/#{{user_id}}' \
  'name=#{{name}}' \
  '{
    "occupation": "#{{occupation}}"
  }'

👉 See all the helpful preferences here

Arguments

  • use: (optional) Set the base api_url you're exploring in your preferences file.
    • It come with the actual api_url value

If you're actually sending an HTTP request:

  • http_method: (optional) 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

Note to self, publish flow is:

  • bin/bump
  • git add . && git commit -m 'Major/Minor/Patch bump x.x.x -> y.y.y'
  • bin/publish
  • git push
  • bin/tag

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-1.0.1.tar.gz (17.8 kB view details)

Uploaded Source

Built Distribution

api_buddy-1.0.1-py3-none-any.whl (24.4 kB view details)

Uploaded Python 3

File details

Details for the file api_buddy-1.0.1.tar.gz.

File metadata

  • Download URL: api_buddy-1.0.1.tar.gz
  • Upload date:
  • Size: 17.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.0.0 CPython/3.13.1 Darwin/24.2.0

File hashes

Hashes for api_buddy-1.0.1.tar.gz
Algorithm Hash digest
SHA256 c98a2fd21f558e863c1667da55685539a78845310a0e500be74f36ea52087f0b
MD5 635fc5c0624286e58db58af0c78e66d1
BLAKE2b-256 5ee4d188019c2d3570ea602bdedceecbf13d7b24bcb480ba78ab0d233b43d75a

See more details on using hashes here.

File details

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

File metadata

  • Download URL: api_buddy-1.0.1-py3-none-any.whl
  • Upload date:
  • Size: 24.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.0.0 CPython/3.13.1 Darwin/24.2.0

File hashes

Hashes for api_buddy-1.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 a0fd344a9d4d8a0579c6694046daca3651cbf12e10125c386f82449f136a8247
MD5 b980c804108ae12dbd1bb7eaa14cf86b
BLAKE2b-256 0e58035f344280221b9e3211c510b1b57f9ecfa1c22531b3e092f42103fdcb6d

See more details on using hashes here.

Supported by

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