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.11.0.dev24796.tar.gz (21.9 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.11.0.dev24796-py3-none-any.whl (24.0 kB view details)

Uploaded Python 3

File details

Details for the file bootgraph-1.11.0.dev24796.tar.gz.

File metadata

  • Download URL: bootgraph-1.11.0.dev24796.tar.gz
  • Upload date:
  • Size: 21.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.0.1 CPython/3.12.8 Linux/5.4.0-146-generic

File hashes

Hashes for bootgraph-1.11.0.dev24796.tar.gz
Algorithm Hash digest
SHA256 3dcbb77b6e6314e51a85a7a33b21b857d6bae368dbca0521803557218b31e1da
MD5 347df9d4606db066f50d097c90a58073
BLAKE2b-256 859d72a370efe3edf38f04a89d0bfdc3b9f07e9ab1619ac781b25b1a7a48db52

See more details on using hashes here.

File details

Details for the file bootgraph-1.11.0.dev24796-py3-none-any.whl.

File metadata

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

File hashes

Hashes for bootgraph-1.11.0.dev24796-py3-none-any.whl
Algorithm Hash digest
SHA256 55ea3997378730a8a9fd47212a58b10d170bbff4a5b7c4a76830e51b15686b36
MD5 0113cd136113838425b9e64063ad6b0e
BLAKE2b-256 1c91c7d54537b006e28980bd4a8831caabdcb5b3c2081d74830a345ed5609b13

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