Skip to main content

Generated NeoDB REST CLI for catalog, shelf, collection, review, and tag workflows

Project description

neodb-rest-cli

Generated CLI for the NeoDB REST API.

This wrapper is built from the public OpenAPI spec at https://neodb.social/api/openapi.json using openapi-cli-gen.

Install

pipx install neodb-rest-cli

The generated package defaults to:

https://neodb.social

Override the target instance with:

export NEODB_REST_CLI_BASE_URL=https://your.instance

Examples

Verified Commands

These commands were run successfully before publishing 0.1.0.

Public/read-only catalog search against https://neodb.social:

neodb-rest-cli catalog search-item --query Dune --category book --output-format json

Result marker: the response included populated data, pages, and count fields.

Additional public/read-only commands:

neodb-rest-cli trending book --output-format json
neodb-rest-cli trending movie --output-format json

Authenticated personal-data workflows:

neodb-rest-cli shelf list-marks-on --type book --output-format json
neodb-rest-cli tag list --output-format table
neodb-rest-cli collection list-user --output-format json

Auth

NeoDB exposes bearer/OAuth-style auth in its spec. Set a token when calling authenticated endpoints:

export NEODB_REST_CLI_TOKEN=...

Notes

This is an unofficial community wrapper. Start with read-only commands before testing shelf, review, note, tag, or collection writes against personal data.

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

neodb_rest_cli-0.1.1.tar.gz (12.3 kB view details)

Uploaded Source

Built Distribution

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

neodb_rest_cli-0.1.1-py3-none-any.whl (13.3 kB view details)

Uploaded Python 3

File details

Details for the file neodb_rest_cli-0.1.1.tar.gz.

File metadata

  • Download URL: neodb_rest_cli-0.1.1.tar.gz
  • Upload date:
  • Size: 12.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.9

File hashes

Hashes for neodb_rest_cli-0.1.1.tar.gz
Algorithm Hash digest
SHA256 e2ddd79f6b4594f7788f35babe14b87e427312404cad3a1e16b173de76cf6fbb
MD5 6795c5695c586d3ef8b5cfb1246f2d87
BLAKE2b-256 f7028ae60e97f07ba7c7ad1101948b86716417cdb01075ec3af4747ccd8f3910

See more details on using hashes here.

File details

Details for the file neodb_rest_cli-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: neodb_rest_cli-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 13.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.9

File hashes

Hashes for neodb_rest_cli-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 29e5d1583bc6edc52a8150a63a3ff9f21b751281e52ef995a7f098bf2495b702
MD5 1d7c314d3d41a8fc05d52e72ef7bf175
BLAKE2b-256 c6103291d987ec4bb3105ef62a2e9d41f5085fd7639e0bab8429bea68af67e0d

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