Initial revision.

Author: TimDumol

.pre-commit-config.yaml

@@ -27,6 +27,11 @@ repos:
 #       --remove-all-unused-imports,
 #       --remove-unused-variables,
 #     ]
+- repo: https://github.com/hadialqattan/pycln
+  rev: v1.0.3
+  hooks:
+    - id: pycln
+      args: [--config=setup.cfg]
 
 - repo: https://github.com/pycqa/isort
   rev: 5.10.1

Pipfile

@@ -0,0 +1,12 @@
+[[source]]
+url = "https://pypi.org/simple"
+verify_ssl = true
+name = "pypi"
+
+[packages]
+strawberry-sqlalchemy-mapper = {editable = true, path = "."}
+
+[dev-packages]
+
+[requires]
+python_version = "3.8"

Pipfile.lock

@@ -0,0 +1,76 @@
+# strawberry-sqlalchemy-mapper
+
+
+    Supplies decorators to automatically instrument strawberry types for provided SQLAlchemy models.
+
+
+Instead of manually listing every column and relationship in a SQLAlchemy model, strawberry-sqlalchemy-mapper
+lets you decorate a class declaration and it will automatically generate the necessary strawberry fields
+for all columns and relationships (subject to the limitations below) in the given model.
+
+## Usage
+
+
+Decorate a type with `strawberry_sqlalchemy_mapper.type()`
+to register it as a strawberry type for the given SQLAlchemy model.
+This will automatically add fields for the model's columns, relationships, association proxies,
+and hybrid properties. For example:
+
+```
+class Employee(Model):
+    id = Column(UUID, primary_key=True)
+    name = Column(String, nullable=False)
+
+
+# in another file
+strawberry_sqlalchemy_mapper = StrawberrySQLAlchemyMapper()
+@strawberry_sqlalchemy_mapper.type(models.Employee)
+class Employee:
+    pass
+```
+
+## Limitations
+
+Natively supports the following SQLAlchemy types:
+
+```
+Integer: int,
+Float: float,
+BigInteger: int,
+Numeric: Decimal,
+DateTime: datetime,
+Date: date,
+Time: time,
+String: str,
+Text: str,
+Boolean: bool,
+Unicode: str,
+UnicodeText: str,
+SmallInteger: int,
+SQLAlchemyUUID: uuid.UUID,
+VARCHAR: str,
+ARRAY[T]: List[T] # PostgreSQL array
+Enum: (the Python enum it is mapped to, which should be @strawberry.enum-decorated)
+```
+
+Additional types can be supported by passing `extra_sqlalchemy_type_to_strawberry_type_map`,
+although support for `TypeDecorator` types is untested.
+
+Association proxies are expected to be of the form `association_proxy('relationship1', 'relationship2')`,
+i.e., both properties are expected to be relationships.
+
+
+## Making Changes & Contributing
+
+This project uses `pre-commit`_, please make sure to install it before making any
+changes::
+
+    pip install pre-commit
+    cd strawberry-sqlalchemy-mapper
+    pre-commit install
+
+It is a good idea to update the hooks to the latest version::
+
+    pre-commit autoupdate
+
+Don't forget to tell your contributors to also install and use pre-commit.