exdrf-al 0.1.8__tar.gz

exdrf_al-0.1.8/PKG-INFO

@@ -0,0 +1,133 @@
+Metadata-Version: 2.4
+Name: exdrf-al
+Version: 0.1.8
+Summary: Use SQLAlchemy with Ex-DRF.
+Author-email: Nicu Tofan <nicu.tofan@gmail.com>
+License-Expression: MIT
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Development Status :: 3 - Alpha
+Classifier: Typing :: Typed
+Requires-Python: >=3.12.2
+Description-Content-Type: text/markdown
+Requires-Dist: SQLAlchemy>=2.0.38
+Requires-Dist: sqlparse>=0.5.3
+Requires-Dist: alembic>=1.16.1
+Requires-Dist: unidecode
+Requires-Dist: exdrf
+Requires-Dist: exdrf-pd
+Provides-Extra: dev
+Requires-Dist: autoflake; extra == "dev"
+Requires-Dist: black; extra == "dev"
+Requires-Dist: build; extra == "dev"
+Requires-Dist: flake8; extra == "dev"
+Requires-Dist: isort; extra == "dev"
+Requires-Dist: mypy; extra == "dev"
+Requires-Dist: pre-commit; extra == "dev"
+Requires-Dist: pyproject-flake8; extra == "dev"
+Requires-Dist: pytest-cov; extra == "dev"
+Requires-Dist: pytest-mock; extra == "dev"
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: twine; extra == "dev"
+Requires-Dist: wheel; extra == "dev"
+Requires-Dist: click<8.2.0,>=8.1.8; extra == "dev"
+
+# SqlAlchemy Support for Ex-DRF
+
+The library provides guidance and support code for using SQLAlchemy with Ex-DRF.
+
+## Usage
+
+Start by basing your models off `Base` from `exdrf_al.base` module.
+It is a rather simple class that allows for model andd fields
+iteration. If you don't want to use it, take a look at the
+implementation of that class for how to extract the information
+you need from your models.
+
+### Models
+
+The library reads the description of models from the sqlAlchemy metadata. On top of that you cad add additional information by adding
+members to the `info` key in the `__table_args__` model attribute.
+
+The keys that are used inside the `info` dictionary are documented
+in `exdrf.resource.ResExtraInfo`, which is the pydantic class that
+parses the information. Here is brief description of the most
+important keys:
+
+- `label`: takes a string that is interpreted by the DSL in `exdrf.
+  label_dsl`; it is used to generate code that computes the label of
+  a record given the record. The `exdrf.label_dsl` module includes
+  code to create python and typescript code from a parsed
+  label definition.
+
+Example:
+
+```python
+class Example(Base):
+    __tablename__ = "the_table"
+    __table_args__ = {
+        "info": {
+            "label": """(if name name (concat "ID:" " id))""",
+        }
+    }
+    id: int
+    name: Optional[str] = None
+```
+
+### Fields
+
+Just like with the models, the model field metadata is used to
+extract the information. Additionally, we use values in the dictionary assigned to the `info` attribute to add additional information.
+
+The keys that are used inside the `info` consist of a common subset
+for all field types and specific keys for each field type. The common keys parsed by the `exdrf.field.FieldInfo` class are documented with
+that class, and each field type is described in its own module under
+`exdrf.field_types`.
+
+Example:
+
+```python
+class Example(Base):
+    __tablename__ = "the_table"
+    id: Mapped[int] = mapped_column(
+        primary_key=True,
+        doc="The unique identifier for a record within its table",
+        info={
+            "sortable": False
+        }
+    )
+    name: Mapped[Optional[str]] = mapped_column(
+        doc="The name of the record",
+        info={
+            "filterable": False,
+            "multiline": True,
+            "min_length": 3,
+        }
+    )
+```
+
+### Relationships
+
+`relationship(..., info={...})` is validated with `exdrf.field_types.ref_base.RelExtraInfo`,
+which extends `exdrf.field.FieldInfo`. Keys such as `direction` and `doc` are
+required or conventional; optional keys from `FieldInfo` apply as well.
+
+When `use_rel` is true on a **non-bridge** `OneToMany` relationship, Qt code
+generation (`exdrf-gen-al2qt`) emits a dedicated editor tab with a
+`DrfRelated`-style transfer list (`Qt{Parent}Rel{Ref}`) instead of an inline
+`Qt{Ref}MuSe` control on category tabs.
+
+Example:
+
+```python
+items: Mapped[Set["Item"]] = relationship(
+    "Item",
+    back_populates="owner",
+    collection_class=set,
+    info={
+        "doc": "Owned items",
+        "direction": "OneToMany",
+        "use_rel": True,
+    },
+)
+```

exdrf_al-0.1.8/README.md

@@ -0,0 +1,99 @@
+# SqlAlchemy Support for Ex-DRF
+
+The library provides guidance and support code for using SQLAlchemy with Ex-DRF.
+
+## Usage
+
+Start by basing your models off `Base` from `exdrf_al.base` module.
+It is a rather simple class that allows for model andd fields
+iteration. If you don't want to use it, take a look at the
+implementation of that class for how to extract the information
+you need from your models.
+
+### Models
+
+The library reads the description of models from the sqlAlchemy metadata. On top of that you cad add additional information by adding
+members to the `info` key in the `__table_args__` model attribute.
+
+The keys that are used inside the `info` dictionary are documented
+in `exdrf.resource.ResExtraInfo`, which is the pydantic class that
+parses the information. Here is brief description of the most
+important keys:
+
+- `label`: takes a string that is interpreted by the DSL in `exdrf.
+  label_dsl`; it is used to generate code that computes the label of
+  a record given the record. The `exdrf.label_dsl` module includes
+  code to create python and typescript code from a parsed
+  label definition.
+
+Example:
+
+```python
+class Example(Base):
+    __tablename__ = "the_table"
+    __table_args__ = {
+        "info": {
+            "label": """(if name name (concat "ID:" " id))""",
+        }
+    }
+    id: int
+    name: Optional[str] = None
+```
+
+### Fields
+
+Just like with the models, the model field metadata is used to
+extract the information. Additionally, we use values in the dictionary assigned to the `info` attribute to add additional information.
+
+The keys that are used inside the `info` consist of a common subset
+for all field types and specific keys for each field type. The common keys parsed by the `exdrf.field.FieldInfo` class are documented with
+that class, and each field type is described in its own module under
+`exdrf.field_types`.
+
+Example:
+
+```python
+class Example(Base):
+    __tablename__ = "the_table"
+    id: Mapped[int] = mapped_column(
+        primary_key=True,
+        doc="The unique identifier for a record within its table",
+        info={
+            "sortable": False
+        }
+    )
+    name: Mapped[Optional[str]] = mapped_column(
+        doc="The name of the record",
+        info={
+            "filterable": False,
+            "multiline": True,
+            "min_length": 3,
+        }
+    )
+```
+
+### Relationships
+
+`relationship(..., info={...})` is validated with `exdrf.field_types.ref_base.RelExtraInfo`,
+which extends `exdrf.field.FieldInfo`. Keys such as `direction` and `doc` are
+required or conventional; optional keys from `FieldInfo` apply as well.
+
+When `use_rel` is true on a **non-bridge** `OneToMany` relationship, Qt code
+generation (`exdrf-gen-al2qt`) emits a dedicated editor tab with a
+`DrfRelated`-style transfer list (`Qt{Parent}Rel{Ref}`) instead of an inline
+`Qt{Ref}MuSe` control on category tabs.
+
+Example:
+
+```python
+items: Mapped[Set["Item"]] = relationship(
+    "Item",
+    back_populates="owner",
+    collection_class=set,
+    info={
+        "doc": "Owned items",
+        "direction": "OneToMany",
+        "use_rel": True,
+    },
+)
+```

exdrf_al-0.1.8/exdrf_al/__version__.py

@@ -0,0 +1,24 @@
+# file generated by vcs-versioning
+# don't change, don't track in version control
+from __future__ import annotations
+
+__all__ = [
+    "__version__",
+    "__version_tuple__",
+    "version",
+    "version_tuple",
+    "__commit_id__",
+    "commit_id",
+]
+
+version: str
+__version__: str
+__version_tuple__: tuple[int | str, ...]
+version_tuple: tuple[int | str, ...]
+commit_id: str | None
+__commit_id__: str | None
+
+__version__ = version = '0.1.8'
+__version_tuple__ = version_tuple = (0, 1, 8)
+
+__commit_id__ = commit_id = 'g450ddaecd'