TypeDAL 3.1.0__py3-none-any.whl → 3.1.1__py3-none-any.whl

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"

{typedal-3.1.0.dist-info → typedal-3.1.1.dist-info}/METADATA

@@ -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.dist-info → typedal-3.1.1.dist-info}/RECORD

@@ -1,4 +1,4 @@
-typedal/__about__.py,sha256=CN-1Orlz3CG7QijS-1qeKVPqHlDwyfxEQpBei5EcMRU,206
+typedal/__about__.py,sha256=OTBqn2XOHv_4-hOGbfVC29HOywMZOEFQS_8L6KP94Y4,206
 typedal/__init__.py,sha256=QQpLiVl9w9hm2LBxey49Y_tCF_VB2bScVaS_mCjYy54,366
 typedal/caching.py,sha256=8UABVAhOlBpL96ykmqhxLaFYOe-XeAh7JoGh57OkxP8,11818
 typedal/cli.py,sha256=3tge8B-YjgjMC6425-RMczmWvpOTfWV5QYPXRY23IWA,18200
@@ -13,7 +13,7 @@ typedal/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 typedal/types.py,sha256=1kGkNX6vfGg6ln84AG558C4Zx5ACRz-emrUTnuy-rRY,3410
 typedal/web2py_py4web_shared.py,sha256=VK9T8P5UwVLvfNBsY4q79ANcABv-jX76YKADt1Zz_co,1539
 typedal/serializers/as_json.py,sha256=ffo152W-sARYXym4BzwX709rrO2-QwKk2KunWY8RNl4,2229
-typedal-3.1.0.dist-info/METADATA,sha256=gCefk7iKuT5OVtj6uj8MpfVJlyu_xTSYF2oEim3ZxJg,7808
-typedal-3.1.0.dist-info/WHEEL,sha256=KGYbc1zXlYddvwxnNty23BeaKzh7YuoSIvIMO4jEhvw,87
-typedal-3.1.0.dist-info/entry_points.txt,sha256=m1wqcc_10rHWPdlQ71zEkmJDADUAnZtn7Jac_6mbyUc,44
-typedal-3.1.0.dist-info/RECORD,,
+typedal-3.1.1.dist-info/METADATA,sha256=TlBsIu6-i1xGFDGHPw76tFtE8I4oambuIGOVEbt2dyE,9270
+typedal-3.1.1.dist-info/WHEEL,sha256=KGYbc1zXlYddvwxnNty23BeaKzh7YuoSIvIMO4jEhvw,87
+typedal-3.1.1.dist-info/entry_points.txt,sha256=m1wqcc_10rHWPdlQ71zEkmJDADUAnZtn7Jac_6mbyUc,44
+typedal-3.1.1.dist-info/RECORD,,