Skip to main content

Official Python SDK for the FeatureJet public developer API.

Project description

FeatureJet Python SDK

Official synchronous Python client for the FeatureJet public developer API.

Install

pip install featurejet

Quickstart

API keys are minted in the FeatureJet dashboard and begin with fj_live_. The SDK sends the key as an Authorization: Bearer header.

from featurejet import (
    ApiPostCreateRequest,
    FeatureJetClient,
    FeatureJetClientConfig,
)

with FeatureJetClient(
    FeatureJetClientConfig(api_key="fj_live_REPLACE_ME"),
) as client:
    posts = client.list_posts("feedback", limit=25, offset=0)
    for post in posts.posts:
        print(post.title, post.vote_count)

    created = client.create_post(
        "feedback",
        ApiPostCreateRequest(
            title="Dark mode",
            body="Please add a system theme",
            tags=["UI"],
        ),
    )
    print(created.id)

The default base URL is https://api.featurejet.com. Configure a different host by passing base_url to FeatureJetClientConfig.

Endpoints

API endpoint SDK method
GET /api/v1/boards list_boards()
GET /api/v1/boards/{slug} get_board(slug)
GET /api/v1/boards/{slug}/posts list_posts(slug, ...)
POST /api/v1/boards/{slug}/posts create_post(slug, request)
GET /api/v1/boards/{slug}/posts/{id} get_post(slug, post_id)
PATCH /api/v1/boards/{slug}/posts/{id} update_post(slug, post_id, request)
DELETE /api/v1/boards/{slug}/posts/{id} delete_post(slug, post_id)
GET /api/v1/boards/{slug}/posts/{id}/votes list_votes(slug, post_id)
GET /api/v1/boards/{slug}/posts/{id}/comments list_comments(slug, post_id)
GET /api/v1/boards/{slug}/roadmap get_roadmap(slug)
GET /api/v1/boards/{slug}/changelog get_changelog(slug, ...)
GET /api/v1/boards/{slug}/ship-stats get_ship_stats(slug, ...)
GET /api/v1/boards/{slug}/analytics get_analytics(slug, ...)

Pagination is explicit: list_posts and get_changelog accept limit and offset. The API defaults to 100 results and permits at most 500.

Errors and rate limits

API error envelopes raise FeatureJetApiError. HTTP 429 responses raise the FeatureJetRateLimitError subclass; its retry_after attribute contains the integer Retry-After value when the response includes one. The public API is limited to 120 requests per minute per API key. The SDK does not retry requests automatically.

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

featurejet-0.2.0.tar.gz (65.8 kB view details)

Uploaded Source

Built Distribution

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

featurejet-0.2.0-py3-none-any.whl (8.8 kB view details)

Uploaded Python 3

File details

Details for the file featurejet-0.2.0.tar.gz.

File metadata

  • Download URL: featurejet-0.2.0.tar.gz
  • Upload date:
  • Size: 65.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for featurejet-0.2.0.tar.gz
Algorithm Hash digest
SHA256 89d4b6b87644292483e51380732c8715470079f97eaa67da83ce35cac350ceae
MD5 e01a642bf603f402231d3e6996b22b6f
BLAKE2b-256 cd8c1b352f540f89afb066dfa4dcb3d702aa4ec36cc3067f8152a6d38ae0bea6

See more details on using hashes here.

Provenance

The following attestation bundles were made for featurejet-0.2.0.tar.gz:

Publisher: publish-sdks.yml on featurejet/featurejet

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file featurejet-0.2.0-py3-none-any.whl.

File metadata

  • Download URL: featurejet-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 8.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for featurejet-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 903fe6292d500ec1065ad5034c0660282f0740f635848d45bb145a448d1ebc8a
MD5 c1da853a92bd2a9a5b6688e19abda799
BLAKE2b-256 d17ad14296b279fdd9e39b0f6e1692950d03a14c3b8cbe24b7fd123d007a10a5

See more details on using hashes here.

Provenance

The following attestation bundles were made for featurejet-0.2.0-py3-none-any.whl:

Publisher: publish-sdks.yml on featurejet/featurejet

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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