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 graphemy tutorial

# Start Environment 
poetry shell

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

# Create a directory for tutorial
mkdir graphemy-tutorial

# Enter into that directory
cd graphemy

# 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


Download files

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

Source Distribution

graphemy-1.0.4.tar.gz (14.4 kB view details)

Uploaded Source

Built Distribution

graphemy-1.0.4-py3-none-any.whl (17.1 kB view details)

Uploaded Python 3

File details

Details for the file graphemy-1.0.4.tar.gz.

File metadata

  • Download URL: graphemy-1.0.4.tar.gz
  • Upload date:
  • Size: 14.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.7.1 CPython/3.12.1 Windows/11

File hashes

Hashes for graphemy-1.0.4.tar.gz
Algorithm Hash digest
SHA256 90d770cfa3bce656734694c6371008268c73bf8b0fc94ebb0c96710eee9a2b59
MD5 758eb55eeb7f8727613dd0b8da14ffd1
BLAKE2b-256 a6a62baa8d5ba64d25ae4485c39a0c158e5c5fb3f9a99762ca29316481d0c2f8

See more details on using hashes here.

File details

Details for the file graphemy-1.0.4-py3-none-any.whl.

File metadata

  • Download URL: graphemy-1.0.4-py3-none-any.whl
  • Upload date:
  • Size: 17.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.7.1 CPython/3.12.1 Windows/11

File hashes

Hashes for graphemy-1.0.4-py3-none-any.whl
Algorithm Hash digest
SHA256 32def3b03f7c0580c8fd725be2b0b00beed44e27933a43cf28a1670fd56eabdf
MD5 ad882b5e8c7dd2ba78712296d337d9c2
BLAKE2b-256 ff563c818798d6188db0ae35251d1633b78f4add03c8b333fad11a5ec07a2927

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