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

Documentation Status codecov CI

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

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 Project Name 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.0b2.tar.gz (10.2 kB view details)

Uploaded Source

Built Distribution

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

graphemy-1.0.0b2-py3-none-any.whl (12.5 kB view details)

Uploaded Python 3

File details

Details for the file graphemy-1.0.0b2.tar.gz.

File metadata

  • Download URL: graphemy-1.0.0b2.tar.gz
  • Upload date:
  • Size: 10.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.6.1 CPython/3.12.0 Windows/10

File hashes

Hashes for graphemy-1.0.0b2.tar.gz
Algorithm Hash digest
SHA256 e2ed0ce6bed4a60fb13f8c4828afd50d189330b9349bcf42edbaf22cefae1b98
MD5 f091983a83dbe67e949ba6496b746f99
BLAKE2b-256 8286db5f03bb4fff1f2777f87ac889848821d19033d4b513333bc776a41374fc

See more details on using hashes here.

File details

Details for the file graphemy-1.0.0b2-py3-none-any.whl.

File metadata

  • Download URL: graphemy-1.0.0b2-py3-none-any.whl
  • Upload date:
  • Size: 12.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.6.1 CPython/3.12.0 Windows/10

File hashes

Hashes for graphemy-1.0.0b2-py3-none-any.whl
Algorithm Hash digest
SHA256 f2cd48937e5ececc5a8e4dbba0cc4350db3463e85c036cbb3729195bcfe52e0a
MD5 95c50b8b625f561e29e6542d04316b18
BLAKE2b-256 1857779188d36e0587978f286893855e0f266a8884fd073724c4654dfda3686e

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