Skip to main content

A low-code data application framework that uses dbt Core and OpenAPI

Project description

Jinjat

Develop data applications with dbt, SQL, and OpenAPI

Installation

pip install jinjat

Create your first API

Create an analysis in analysis/my_first_api.sql:

{%- set query = request().query %}

select '{{query.example}}' as col1

And create a YML file in analysis/schema.yml:

version: 2

analyses:
  - name: my_first_api
    config:
      jinjat:
        method: get
        openapi:
          parameters:
            - in: query
              name: example
              schema:
                type: number

Start Jinjat as follows:

jinjat serve --project-dir [YOUR_DBT_PROJECT_DIRECTORY]

And then run the following CURL command to test the API:

curl -XGET 'http://127.0.0.1:8581?example=value'

It should return the following response:

[
  "col1": "3"
]

Jinjat uses OpenAPI to validate the requests and create an API documentation automatically for your API.

Integrations

poetry install --extras "duckdb"

Playground

poetry install --extras "playground"

Installation

pip install jinjat[playground]

Jinjat Playground is a Streamlit app that lets you develop APIs in your browser. Once you write the template, you can save it to your dbt project as an analysis and expose the API.

Refine.dev Integration

Installation

pip install jinjat[refine]

Jinjat Refine integration creates a Refine app from your OpenAPI spec

Jinjat is a fork of dbt-osmosis

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

jinjat-0.2.tar.gz (2.4 MB view details)

Uploaded Source

Built Distribution

jinjat-0.2-py3-none-any.whl (2.4 MB view details)

Uploaded Python 3

File details

Details for the file jinjat-0.2.tar.gz.

File metadata

  • Download URL: jinjat-0.2.tar.gz
  • Upload date:
  • Size: 2.4 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.13 CPython/3.9.12 Darwin/22.2.0

File hashes

Hashes for jinjat-0.2.tar.gz
Algorithm Hash digest
SHA256 af57a74f467d7bca173a35d8f1d3891e7d7241e35c23de2c25f1178c03a56161
MD5 a58c9f2d5628ad158dbabf2997796bd9
BLAKE2b-256 7f6b3012d50d15c6d8f5b881073b8ab6a815939e7f8411e939cd88852bdb81b7

See more details on using hashes here.

File details

Details for the file jinjat-0.2-py3-none-any.whl.

File metadata

  • Download URL: jinjat-0.2-py3-none-any.whl
  • Upload date:
  • Size: 2.4 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.13 CPython/3.9.12 Darwin/22.2.0

File hashes

Hashes for jinjat-0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 73843e3c6bfc30af5ce715b94cdff9d30bbfc21d9cf3c7a00c446ba7ed8f6d1a
MD5 9762d6500625d4e5ac47be56676ded02
BLAKE2b-256 e193385a6183558044d978aef5eedefa305c2fb084c5e75099e63bafb325fdaa

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