TypeDAL 3.1.0__tar.gz → 3.1.1__tar.gz

{typedal-3.1.0 → typedal-3.1.1}/CHANGELOG.md

@@ -2,6 +2,12 @@
 
 <!--next-version-placeholder-->
 
+## v3.1.1 (2024-04-16)
+
+### Documentation
+
+* More info about configuration and the cli ([`950295d`](https://github.com/trialandsuccess/TypeDAL/commit/950295d1003a053ffa9590292a8678435a379490))
+
 ## v3.1.0 (2024-04-16)
 
 ### Feature

{typedal-3.1.0 → typedal-3.1.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: TypeDAL
-Version: 3.1.0
+Version: 3.1.1
 Summary: Typing support for PyDAL
 Project-URL: Documentation, https://typedal.readthedocs.io/
 Project-URL: Issues, https://github.com/trialandsuccess/TypeDAL/issues
@@ -60,7 +60,7 @@ Description-Content-Type: text/markdown
 Typing support for [PyDAL](http://web2py.com/books/default/chapter/29/6).
 This package aims to improve the typing support for PyDAL. By using classes instead of the define_table method,
 type hinting the result of queries can improve the experience while developing. In the background, the queries are still
-generated and executed by pydal itself, this package only proves some logic to properly pass calls from class methods to
+generated and executed by pydal itself, this package only provides some logic to properly pass calls from class methods to
 the underlying `db.define_table` pydal Tables.
 
 - `TypeDAL` is the replacement class for DAL that manages the code on top of DAL.
@@ -76,13 +76,49 @@ the underlying `db.define_table` pydal Tables.
 
 Version 2.0 also introduces more ORM-like funcionality.
 Most notably, a Typed Query Builder that sees your table classes as models with relationships to each other.
-See [3. Building Queries](https://github.com/trialandsuccess/TypeDAL/blob/master/docs/3_building_queries.md) for more
+See [3. Building Queries](https://typedal.readthedocs.io/en/stable/3_building_queries/) for more
 details.
 
-## Quick Overview
+## CLI
+The Typedal CLI provides a convenient interface for generating SQL migrations for [edwh-migrate](https://github.com/educationwarehouse/migrate#readme)
+from PyDAL or TypeDAL configurations using [pydal2sql](https://github.com/robinvandernoord/pydal2sql). 
+It offers various commands to streamline database management tasks.
 
-Below you'll find a quick overview of translation from pydal to TypeDAL. For more info,
-see [the docs](https://typedal.readthedocs.io/en/latest/).
+### Usage
+
+```bash
+typedal --help
+```
+
+## Options
+
+- `--show-config`: Toggle to show configuration details. Default is `no-show-config`.
+- `--version`: Toggle to display version information. Default is `no-version`.
+- `--install-completion`: Install completion for the current shell.
+- `--show-completion`: Show completion for the current shell, for copying or customization.
+- `--help`: Display help message and exit.
+
+## Commands
+
+- `cache.clear`: Clear expired items from the cache.
+- `cache.stats`: Show caching statistics.
+- `migrations.fake`: Mark one or more migrations as completed in the database without executing the SQL code.
+- `migrations.generate`: Run `pydal2sql` based on the TypeDAL configuration.
+- `migrations.run`: Run `edwh-migrate` based on the TypeDAL configuration.
+- `setup`: Interactively setup a `[tool.typedal]` entry in the local `pyproject.toml`.
+
+### Configuration
+
+TypeDAL and its CLI can be configured via `pyproject.toml`.  
+See [6. Migrations](https://typedal.readthedocs.io/en/stable/6_migrations/) for more information about configuration.
+
+
+## TypeDAL for PyDAL users - Quick Overview
+
+Below you'll find a quick overview of translation from pydal to TypeDAL.  
+For more info, see **[the docs](https://typedal.readthedocs.io/en/latest/)**.
+
+---
 
 ### Translations from pydal to typedal
 
@@ -259,7 +295,7 @@ row: TableName = db.table_name(id=1)
 
 ### All Types
 
-See [2. Defining Tables](docs/2_defining_tables.md)
+See [2. Defining Tables](https://typedal.readthedocs.io/en/stable/2_defining_tables/)
 
 ## Caveats
 

{typedal-3.1.0 → typedal-3.1.1}/README.md

@@ -10,7 +10,7 @@
 Typing support for [PyDAL](http://web2py.com/books/default/chapter/29/6).
 This package aims to improve the typing support for PyDAL. By using classes instead of the define_table method,
 type hinting the result of queries can improve the experience while developing. In the background, the queries are still
-generated and executed by pydal itself, this package only proves some logic to properly pass calls from class methods to
+generated and executed by pydal itself, this package only provides some logic to properly pass calls from class methods to
 the underlying `db.define_table` pydal Tables.
 
 - `TypeDAL` is the replacement class for DAL that manages the code on top of DAL.
@@ -26,13 +26,49 @@ the underlying `db.define_table` pydal Tables.
 
 Version 2.0 also introduces more ORM-like funcionality.
 Most notably, a Typed Query Builder that sees your table classes as models with relationships to each other.
-See [3. Building Queries](https://github.com/trialandsuccess/TypeDAL/blob/master/docs/3_building_queries.md) for more
+See [3. Building Queries](https://typedal.readthedocs.io/en/stable/3_building_queries/) for more
 details.
 
-## Quick Overview
+## CLI
+The Typedal CLI provides a convenient interface for generating SQL migrations for [edwh-migrate](https://github.com/educationwarehouse/migrate#readme)
+from PyDAL or TypeDAL configurations using [pydal2sql](https://github.com/robinvandernoord/pydal2sql). 
+It offers various commands to streamline database management tasks.
 
-Below you'll find a quick overview of translation from pydal to TypeDAL. For more info,
-see [the docs](https://typedal.readthedocs.io/en/latest/).
+### Usage
+
+```bash
+typedal --help
+```
+
+## Options
+
+- `--show-config`: Toggle to show configuration details. Default is `no-show-config`.
+- `--version`: Toggle to display version information. Default is `no-version`.
+- `--install-completion`: Install completion for the current shell.
+- `--show-completion`: Show completion for the current shell, for copying or customization.
+- `--help`: Display help message and exit.
+
+## Commands
+
+- `cache.clear`: Clear expired items from the cache.
+- `cache.stats`: Show caching statistics.
+- `migrations.fake`: Mark one or more migrations as completed in the database without executing the SQL code.
+- `migrations.generate`: Run `pydal2sql` based on the TypeDAL configuration.
+- `migrations.run`: Run `edwh-migrate` based on the TypeDAL configuration.
+- `setup`: Interactively setup a `[tool.typedal]` entry in the local `pyproject.toml`.
+
+### Configuration
+
+TypeDAL and its CLI can be configured via `pyproject.toml`.  
+See [6. Migrations](https://typedal.readthedocs.io/en/stable/6_migrations/) for more information about configuration.
+
+
+## TypeDAL for PyDAL users - Quick Overview
+
+Below you'll find a quick overview of translation from pydal to TypeDAL.  
+For more info, see **[the docs](https://typedal.readthedocs.io/en/latest/)**.
+
+---
 
 ### Translations from pydal to typedal
 
@@ -209,7 +245,7 @@ row: TableName = db.table_name(id=1)
 
 ### All Types
 
-See [2. Defining Tables](docs/2_defining_tables.md)
+See [2. Defining Tables](https://typedal.readthedocs.io/en/stable/2_defining_tables/)
 
 ## Caveats
 

{typedal-3.1.0 → typedal-3.1.1}/docs/6_migrations.md

@@ -58,9 +58,11 @@ them to your .env file (optionally prefixed with `TYPEDAL`_):
 TYPEDAL_DATABASE = "psql://user:password@host:5432/database"
 ```
 
+Settings passed directly to `TypeDAL()` will overwrite config values.
+
 ### Multiple Connections
 
-Thie configuration allows you to define multiple database connections and specify which one to use through environment
+Thie configuration allows you to define multiple database connections and specify which one `TypeDAL()` will use through environment
 variables.
 
 ```toml

{typedal-3.1.0 → typedal-3.1.1}/docs/7_mixins.md

@@ -1,4 +1,4 @@
-## Mixins
+# 7. Mixins
 
 Mixins allow you to encapsulate reusable fields and behaviors that can be easily
 added to your database models. On this page, we'll walk through the usage
@@ -6,7 +6,7 @@ of two example mixins provided by TypeDAL: `TimestampsMixin` for automatic times
 URL-friendly slugs. Additionally, we'll demonstrate how you can create your own custom mixins to tailor functionality to
 your app's specific needs.
 
-### Using `TimestampsMixin`
+## Using `TimestampsMixin`
 
 The `TimestampsMixin` adds automatic timestamping functionality to your models. It includes two fields: `created_at`
 and `updated_at`, which record the creation and last update times respectively.
@@ -26,7 +26,7 @@ class MyTable(TypedTable, TimestampsMixin):
 # Now, whenever you create or update a record in MyTable, the 'created_at' and 'updated_at' timestamps will be automatically managed.
 ```
 
-### Using `SlugMixin`
+## Using `SlugMixin`
 
 The `SlugMixin` adds a "slug" field to your models, which is a URL-friendly version of another field's value. This is
 typically used for SEO-friendly URLs. To prevent duplicates, some random bytes are appended at the end of the slug.
@@ -47,7 +47,7 @@ class MyTable(TypedTable, SlugMixin, slug_field="title"): # optionally add `slug
 # Now, whenever you insert a record into MyTable, the 'slug' field will be automatically generated based on the 'title' field.
 ```
 
-### Creating Custom Mixins
+## Creating Custom Mixins
 
 To create your own mixins for additional functionality, follow these steps:
 

{typedal-3.1.0 → typedal-3.1.1}/mkdocs.yml

@@ -2,11 +2,13 @@ site_name: TypeDAL
 site_description: Welcome to TypeDAL's documentation
 site_url: https://github.com/trialandsuccess/typedal
 nav:
-  - Getting Started: 1_getting_started.md
-  - Defining Tables: 2_defining_tables.md
-  - Building Queries: 3_building_queries.md
-  - Relationships: 4_relationships.md
-  - py4web: 5_py4web.md
+  - 1. Getting Started: 1_getting_started.md
+  - 2. Defining Tables: 2_defining_tables.md
+  - 3. Building Queries: 3_building_queries.md
+  - 4. Relationships: 4_relationships.md
+  - 5. py4web: 5_py4web.md
+  - 6. Migrations: 6_migrations.md
+  - 7. Mixins: 7_mixins.md
 
 #markdown_extensions:
 #  - pymdownx.highlight:

{typedal-3.1.0 → typedal-3.1.1}/src/typedal/__about__.py

@@ -5,4 +5,4 @@ This file contains the Version info for this package.
 # SPDX-FileCopyrightText: 2023-present Robin van der Noord <robinvandernoord@gmail.com>
 #
 # SPDX-License-Identifier: MIT
-__version__ = "3.1.0"
+__version__ = "3.1.1"