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.15.0.dev26883.tar.gz (24.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.15.0.dev26883-py3-none-any.whl (26.9 kB view details)

Uploaded Python 3

File details

Details for the file bootgraph-1.15.0.dev26883.tar.gz.

File metadata

  • Download URL: bootgraph-1.15.0.dev26883.tar.gz
  • Upload date:
  • Size: 24.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.1.2 CPython/3.12.8 Linux/5.4.0-146-generic

File hashes

Hashes for bootgraph-1.15.0.dev26883.tar.gz
Algorithm Hash digest
SHA256 0423c755627bbf135007706f2c9e8254df4ed86a13e897efa90e86534a2cd97a
MD5 1f750756a98790f4fd10d9d7bbb84289
BLAKE2b-256 9112da2706aab39f1c29ea7e5319cf9f0bfa86edcb8437afa2d20a8ebb6ee98e

See more details on using hashes here.

File details

Details for the file bootgraph-1.15.0.dev26883-py3-none-any.whl.

File metadata

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

File hashes

Hashes for bootgraph-1.15.0.dev26883-py3-none-any.whl
Algorithm Hash digest
SHA256 5f7df122c5cd15d841504d0338e48c93b4e5344ce862a32d0cd64d41d27518b0
MD5 0cb015c279553f3a887dfe84ddd85c37
BLAKE2b-256 189600768550d337c0ec60e5d7e1ec62418e5bb1c3a1bf1def3818fedb4c093e

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