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.dev24840.tar.gz (22.1 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.dev24840-py3-none-any.whl (24.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: bootgraph-1.11.0.dev24840.tar.gz
  • Upload date:
  • Size: 22.1 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.dev24840.tar.gz
Algorithm Hash digest
SHA256 dc6f19fdd6dff3d8cbc64f3b328cb32ad42f1e0cfb4a2f3b37e514266aa94990
MD5 088512559b07487842dd4ab1e5ab4c5e
BLAKE2b-256 f2a89b7e670d57b9317abae289b1b8410dd0f4459e7b5a2d66c7fc45fa7a8ff0

See more details on using hashes here.

File details

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

File metadata

  • Download URL: bootgraph-1.11.0.dev24840-py3-none-any.whl
  • Upload date:
  • Size: 24.2 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.dev24840-py3-none-any.whl
Algorithm Hash digest
SHA256 ed05196d3ea4bb7dac6a41a567b15e647a8b4193e5466719ab8a0a47b87824dc
MD5 2454165eae3b50f0d930ac715327ae52
BLAKE2b-256 986d5922f1a58b8b599b67cc54c7dc45ae5ef6370dc97c5e942a2674b61f47de

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