Skip to main content

A Python library for integrating SQLModel and Strawberry, providing a seamless GraphQL integration with FastAPI and advanced features for database interactions.

Project description

GRAPHEMY

Integrating SQLModel and Strawberry, providing a seamless GraphQL integration with Databases easy and fast.

Documentation Status codecov CI Package version


Documentation: https://graphemy.readthedocs.io

Source Code: https://github.com/MDoreto/graphemy


Overview

The Graphemy is designed to simplify and streamline the integration of SQLModel and Strawberry in Python projects. This library allows you to create a single class model, which, once declared, automatically provides GraphQL queries via Strawberry. These queries can be easily integrated into a FastAPI backend. All generated routes include filters on all fields, including a custom date filter. Additionally, it facilitates the creation of mutations for data modification and deletion by simply setting a variable in the model. The library also handles table relationships efficiently using Strawberry's dataloaders, providing a significant performance boost. Moreover, it offers a pre-configured authentication setup, which can be configured with just two functions.

Features

  • Integration of SQLModel and Strawberry for GraphQL support.
  • Automatic generation of GraphQL queries for FastAPI.
  • Powerful filtering capabilities, including custom date filters.
  • Effortless creation of mutations for data manipulation.
  • Efficient handling of table relationships using Strawberry's dataloaders.
  • Pre-configured authentication setup for easy configuration.

Prerequisites

Before you begin using Graphemy, it is highly recommended that you have some prior knowledge of the essential libraries upon which this project is built. This will help you make the most of the features and carry out integrations more effectively. Please make sure you are familiar with the following libraries:

FastAPI: A modern framework for building fast web APIs with Python. If you are not already familiar with FastAPI, you can refer to the FastAPI documentation.

SQLModel: An object-relational mapping (ORM) library for Python that simplifies and streamlines database interactions. To learn more about SQLModel, visit the SQLModel documentation.

Strawberry: A Python library for declaratively creating GraphQL schemas. For in-depth information on using Strawberry, access the Strawberry documentation.

Having a solid understanding of these libraries is crucial to making the most of Graphemy and effortlessly creating GraphQL APIs.

Create a Project

I recomend you use Poetry, but you can use the enviroment manager that you want. So if you are using poetry, start the project:

# Create poetry project
poetry new bootgraph tutorial

# Start Environment 
poetry shell

You can also use the environment manager wanted, such as virtualenv

# Create a directory for tutorial
mkdir bootgraph-tutorial

# Enter into that directory
cd bootgraph

# Create virtual environment
python -m venv venv

#Start Environment
venv/Scripts/Activate

Requirements

Now install Graphemy :)

poetry add graphemy

Or using default python env with pip:

pip install graphemy

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

bootgraph-1.8.0.dev24099.tar.gz (21.3 kB view details)

Uploaded Source

Built Distribution

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

bootgraph-1.8.0.dev24099-py3-none-any.whl (23.4 kB view details)

Uploaded Python 3

File details

Details for the file bootgraph-1.8.0.dev24099.tar.gz.

File metadata

  • Download URL: bootgraph-1.8.0.dev24099.tar.gz
  • Upload date:
  • Size: 21.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.0.0 CPython/3.12.8 Linux/5.4.0-146-generic

File hashes

Hashes for bootgraph-1.8.0.dev24099.tar.gz
Algorithm Hash digest
SHA256 4214782cd6e90e9c4d57469d786f6f557060c83b75f2488fbd8ed5e117276d24
MD5 a690ed4236b15726368778d4be0e17fd
BLAKE2b-256 e412b0e544ab87cb2c34ee2418029de3e0ff87f5a7791ad8c841d19f0d551b19

See more details on using hashes here.

File details

Details for the file bootgraph-1.8.0.dev24099-py3-none-any.whl.

File metadata

  • Download URL: bootgraph-1.8.0.dev24099-py3-none-any.whl
  • Upload date:
  • Size: 23.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.0.0 CPython/3.12.8 Linux/5.4.0-146-generic

File hashes

Hashes for bootgraph-1.8.0.dev24099-py3-none-any.whl
Algorithm Hash digest
SHA256 c5c37ca42fa7b2c17b9afed83e4cadae77ae6c13b9c40bcbe3c56c96b37eb729
MD5 abc128c11717e2842e4ef080c69c2ca7
BLAKE2b-256 6fd83b6c7f3205aedf1dc2a776afe26b7a3eceb2a531bc27a46381ff7d2bb0bb

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