half-orm-dev 0.16.0a1__py3-none-any.whl

half_orm_dev-0.16.0a1.dist-info/METADATA

@@ -0,0 +1,314 @@
+Metadata-Version: 2.4
+Name: half_orm_dev
+Version: 0.16.0a1
+Summary: half_orm development Framework.
+Home-page: https://github.com/collorg/halfORM_dev
+Author: Joël Maïzi
+Author-email: joel.maizi@collorg.org
+License: GNU General Public License v3 (GPLv3)
+Keywords: postgres,relation-object mapping
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Software Development :: Build Tools
+Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
+Classifier: Programming Language :: Python :: 3.6
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+License-File: AUTHORS
+Requires-Dist: GitPython
+Requires-Dist: click
+Requires-Dist: pydash
+Requires-Dist: half_orm>=0.14.0
+Requires-Dist: pytest
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: keywords
+Dynamic: license
+Dynamic: license-file
+Dynamic: requires-dist
+Dynamic: summary
+
+# halfORM packager (early alpha stage)
+
+> **📢 Project Evolution Notice**
+>
+> **halfORM_dev is being redesigned to integrate with halfORM 0.16's new extension system.**
+>
+> This project will be refactored as `half-orm-dev` to provide development tools through the unified `half_orm` CLI interface. The core functionality (project management, database patches, code generation) will remain the same, but the integration and command structure will be modernized.
+>
+> **Current Status:**
+> - halfORM core 0.16 with extension is about to be released
+> - halfORM_dev refactoring will start soon
+> - New `half-orm-dev` extension planned for Q3 2025
+>
+> **What's Changing:**
+> - Commands will integrate with `half_orm dev` instead of standalone `hop`
+> - Extension auto-discovery and security model
+> - Simplified installation and configuration
+> - Consistent CLI experience across all halfORM tools
+>
+> **For Current Users:**
+> The existing halfORM_dev will continue to work as-is. The new extension will provide a migration path when ready.
+>
+> **Stay Updated:**
+> Follow progress in [halfORM Discussions](https://github.com/collorg/halfORM/discussions) and [halfORM Issues](https://github.com/collorg/halfORM/issues).
+
+---
+
+THIS DOC IS A WORK IN PROGRESS...
+
+This package allows you to patch/test a PostgreSQL model and its associated
+Python code using the `hop` command.
+
+It is based on the [half_orm](https://github.com/collorg/halfORM)
+PostgreSQL → Python relation object mapper.
+
+
+## Installation
+
+Run `pip install half_orm_dev`.
+
+## help
+
+```
+$ hop --help
+Usage: hop [OPTIONS] COMMAND [ARGS]...
+
+  Generates/Synchronises/Patches a python package from a PostgreSQL database
+
+Options:
+  -v, --version
+  --help         Show this message and exit.
+
+Commands:
+  new     Creates a new hop project named <package_name>.
+  patch   Applies the next patch
+  test    Tests some common pitfalls.
+  update  Updates the Python code with the changes made to the model.
+  ```
+
+## Create a new package for your database: *`hop new`*
+
+```
+hop new <package name>
+```
+
+**WARNING!** The `hop new` command will add to your database
+two new schemas: `half_orm_meta` and "`half_orm_meta.view`".
+The table `half_orm_meta.release` will containt the patch history
+of your model (see `hop patch` bellow).
+
+
+```
+$ hop new pagila
+HALFORM_CONF_DIR: /home/joel/.halform
+Using '/home/joel/.halform/pagila' file for connexion.
+Initializing git with a 'main' branch.
+Initializing the patch system for the 'pagila' database.
+Patch system initialized at release '0.0.0'.
+
+The hop project 'pagila' has been created.
+```
+
+The tree command shows you the repartition of the modules in your package.
+
+```
+$ tree pagila
+pagila
+├── Backups
+│   └── pagila-pre-patch.sql
+├── pagila
+│   ├── base_test.py
+│   ├── db_connector.py
+│   ├── __init__.py
+│   └── public
+│       ├── actor_info.py
+│       ├── actor_info_test.py
+│       ├── actor.py
+│       ├── actor_test.py
+│       ├── address.py
+│       ├── address_test.py
+│       ├── category.py
+│       ├── category_test.py
+│       ├── city.py
+│       ├── city_test.py
+│       ├── country.py
+│       ├── country_test.py
+│       ├── customer_list.py
+│       ├── customer_list_test.py
+│       ├── customer.py
+│       ├── customer_test.py
+│       ├── film_actor.py
+│       ├── film_actor_test.py
+│       ├── film_category.py
+│       ├── film_category_test.py
+│       ├── film_list.py
+│       ├── film_list_test.py
+│       ├── film.py
+│       ├── film_test.py
+│       ├── __init__.py
+│       ├── inventory.py
+│       ├── inventory_test.py
+│       ├── language.py
+│       ├── language_test.py
+│       ├── nicer_but_slower_film_list.py
+│       ├── nicer_but_slower_film_list_test.py
+│       ├── payment_p2020_01.py
+│       ├── payment_p2020_01_test.py
+│       ├── payment_p2020_02.py
+│       ├── payment_p2020_02_test.py
+│       ├── payment_p2020_03.py
+│       ├── payment_p2020_03_test.py
+│       ├── payment_p2020_04.py
+│       ├── payment_p2020_04_test.py
+│       ├── payment_p2020_05.py
+│       ├── payment_p2020_05_test.py
+│       ├── payment_p2020_06.py
+│       ├── payment_p2020_06_test.py
+│       ├── payment.py
+│       ├── payment_test.py
+│       ├── rental.py
+│       ├── rental_test.py
+│       ├── sales_by_film_category.py
+│       ├── sales_by_film_category_test.py
+│       ├── sales_by_store.py
+│       ├── sales_by_store_test.py
+│       ├── staff_list.py
+│       ├── staff_list_test.py
+│       ├── staff.py
+│       ├── staff_test.py
+│       ├── store.py
+│       └── store_test.py
+├── Patches
+│   └── README
+├── Pipfile
+├── README.md
+└── setup.py
+```
+
+Once created, go to the newly created directory
+
+```
+cd pagila
+```
+
+## The organisation
+
+```
+$ tree -d
+.
+├── Backups
+├── pagila
+│   └── public
+└── Patches
+```
+
+You will now be able to manage your package with the `hop` command.
+
+## Get the status of your package: *`hop`*
+
+```
+$ hop 
+STATUS
+
+        connection_file_name: pagila
+        package_name: pagila
+        
+CURRENT RELEASE: 0.0.0: 2021-09-03 at 11:54:22+02:00
+No new release to apply after 0.0.0.
+Next possible releases: 0.0.1, 0.1.0, 1.0.0.
+hop --help to get help.
+```
+
+## Patch your model: *`hop patch`*
+
+```
+$ hop patch
+No new release to apply after 0.0.0.
+Next possible releases: 0.0.1, 0.1.0, 1.0.0.
+```
+
+The patch system will try to find a next suitable patch to apply from the
+last release number. If the last patch is X.Y.Z, `hop patch` will try in order
+X.Y.<Z+1>, X.<Y+1>.Z, <X+1>.Y.Z.
+
+
+To prepare a new patch, run `hop patch -p <patch_level>` where patch_level is one
+of ['patch', 'minor', 'major']. The command will create a directory in 
+`Patches/X/Y/Z` with a CHANGELOG.md description file. You can add in this
+directory a series of patches scripts.
+The scripts are applied in alphabetical order and can only be of two types:
+
+
+* SQL with .sql extension
+* Python with .py extension
+
+If there is a suitable patch to apply, hop will create a branch `hop_<release>`,
+backup the database in `Backups/<dbname>-<release>.sql`, apply the patch and
+update the Python code.
+
+In development, you will frequently need to adjust a patch.
+To replay a patch, simply run `hop patch` again.
+
+To revert to the previous patch run `hop patch -r`.
+If your git repo is not clean, `hop patch` will complain. You can use `hop patch -f`
+to avoid the warning.
+
+You can use git as you wish during this phase.
+## Generate a release (CI): *`hop release`* NotImplented
+
+* `hop release -a` for alpha
+* `hop release -c` for release candidate
+* `hop release -p` for production
+
+## Test your code
+
+Each `hop patch` should test and report any error.
+
+The package is test ready. For each module there is a test
+
+```
+$ pytest pagila/
+================= test session starts =================
+platform linux -- Python 3.8.5, pytest-6.2.5, py-1.10.0, pluggy-1.0.0
+rootdir: /home/joel/Dev/halfORM_packager/tmp/pagila
+collected 28 items                                    
+
+pagila/public/actor_info_test.py .              [  3%]
+pagila/public/actor_test.py .                   [  7%]
+pagila/public/address_test.py .                 [ 10%]
+pagila/public/category_test.py .                [ 14%]
+pagila/public/city_test.py .                    [ 17%]
+pagila/public/country_test.py .                 [ 21%]
+pagila/public/customer_list_test.py .           [ 25%]
+pagila/public/customer_test.py .                [ 28%]
+pagila/public/film_actor_test.py .              [ 32%]
+pagila/public/film_category_test.py .           [ 35%]
+pagila/public/film_list_test.py .               [ 39%]
+pagila/public/film_test.py .                    [ 42%]
+pagila/public/inventory_test.py .               [ 46%]
+pagila/public/language_test.py .                [ 50%]
+pagila/public/nicer_but_slower_film_list_test.py . [ 53%]
+                                                [ 53%]
+pagila/public/payment_p2020_01_test.py .        [ 57%]
+pagila/public/payment_p2020_02_test.py .        [ 60%]
+pagila/public/payment_p2020_03_test.py .        [ 64%]
+pagila/public/payment_p2020_04_test.py .        [ 67%]
+pagila/public/payment_p2020_05_test.py .        [ 71%]
+pagila/public/payment_p2020_06_test.py .        [ 75%]
+pagila/public/payment_test.py .                 [ 78%]
+pagila/public/rental_test.py .                  [ 82%]
+pagila/public/sales_by_film_category_test.py .  [ 85%]
+pagila/public/sales_by_store_test.py .          [ 89%]
+pagila/public/staff_list_test.py .              [ 92%]
+pagila/public/staff_test.py .                   [ 96%]
+pagila/public/store_test.py .                   [100%]
+
+================= 28 passed in 0.18s ==================
+```

half_orm_dev-0.16.0a1.dist-info/RECORD

@@ -0,0 +1,38 @@
+half_orm_dev/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+half_orm_dev/changelog.py,sha256=dWgwEYvbRfvisRwQ9OgTFv2Dy0jNzrQyYln5L6RjRBo,4294
+half_orm_dev/cli_extension.py,sha256=EFMLw3zmXCi7uev7GRGWmmuMAIpbWfPiMy8Qk2-Fhd0,5418
+half_orm_dev/database.py,sha256=pceI49B_cC_5G3pLBTVG5kRFNdh4LBOspPl-3NA5lQw,4538
+half_orm_dev/db_conn.py,sha256=PNL62_l1ERBMXJJp95ytwzSYQR-0VXO4IZVTmt6FKlo,4490
+half_orm_dev/hgit.py,sha256=gAmuyFVhYqF3tLhucB7MO1b4GlVYNZrCupZo7HR5tXM,8132
+half_orm_dev/hop.py,sha256=MXae6KV8bRsnXznfItk1V3PaEefLbV3znxgKDD5vCU8,5237
+half_orm_dev/manifest.py,sha256=1BKDQf64baI8KOacW6Jx6IiopUtYitZcM44wrBwQhQw,1265
+half_orm_dev/modules.py,sha256=cmsh-f9L6XK55oaVwYbrQScFOR9Iia6-nOOzzAjKePI,14206
+half_orm_dev/patch.py,sha256=QHSg2kywgJdf2QLul7e9G7zg2agRRdOItspLYikQU4Y,14634
+half_orm_dev/repo.py,sha256=lbcRnnb4T1L2yb5LLsNh0K62U1xIGNQdUy7bgp4Bd7E,8966
+half_orm_dev/utils.py,sha256=PJ_JcWNowswbnCaWvecKLFB36XzPiNseZb4YIUBtBHM,333
+half_orm_dev/version.txt,sha256=VtObc4nHx1TqD5eylVGLG28O2tD6NaXw81y3nN_X3CY,10
+half_orm_dev/patches/log,sha256=n7MNnGR09Obd87gXLzIi6zA76sI4RhOJzC25wb0TbKE,22
+half_orm_dev/patches/0/1/0/00_half_orm_meta.database.sql,sha256=gMZ94YlyrftxcqDn0l-ToCTee4A_bnP58DpHcIT_T1w,1074
+half_orm_dev/patches/0/1/0/01_alter_half_orm_meta.hop_release.sql,sha256=nhRbDi6sUenvVfOnoRuWSbLEC1cEfzrXbxDof2weq04,183
+half_orm_dev/patches/0/1/0/02_half_orm_meta.view.hop_penultimate_release.sql,sha256=Bd0lXJ6vC0JNe06yqTWYVSrwVDElCI3McSS5pm-Ijlo,306
+half_orm_dev/patches/sql/half_orm_meta.sql,sha256=Vl2YzEWpWdam-tC0ZE8iNMeTRzEHpxtNhdBThbHb2u4,5864
+half_orm_dev/templates/.gitignore,sha256=aHy4XGngr0kBPXSZHnNkDL4R2rK8hF4Lx2FM3I-O8cM,99
+half_orm_dev/templates/MANIFEST.in,sha256=53BeBuKi8UtBWB6IG3VQZk9Ow8Iye6Zs14sP-gVyVDA,25
+half_orm_dev/templates/Pipfile,sha256=u3lGJSk5HZwz-EOTrOdBYrkhGV6zgVtrrRPivrO5rmA,182
+half_orm_dev/templates/README,sha256=Jb26Qv41KGSfD-6FpyqF7EEiPpI5nmhtpdsCJolg1pA,904
+half_orm_dev/templates/base_test,sha256=UUtpB9JbSKtkXv2LUOOrMKsRPc3_ZRXWImSHtibs-II,445
+half_orm_dev/templates/init_module_template,sha256=1cQeoVr_fL0rVXNwGTgaV7RCrFGBx4ybP-1HTPGI7lM,169
+half_orm_dev/templates/module_template_1,sha256=-Zmq-v1vyzVMtHP0ECFUeVl26AA3UUYoMxPXL_dtIJU,256
+half_orm_dev/templates/module_template_2,sha256=lQpgEX89yHHQlposwCLvBYv0P0J-4G9ZMIm13-1oZZA,165
+half_orm_dev/templates/module_template_3,sha256=yjpQYT0EsIA6TI8KeyFaw_nHP9zCBma6o7g3P1MDs_M,187
+half_orm_dev/templates/relation_test,sha256=QFIPu6J3Gnc4IQTTVN7Szm0UmMg6N_j-IMpmpi-zluc,460
+half_orm_dev/templates/setup.py,sha256=hnnJ4cLnECbxzaTLeVBYd3aR-2kk6KuF1xkAoXWQN5A,2061
+half_orm_dev/templates/sql_adapter,sha256=kAP5y7Qml3DKsbZLUeoVpeXjbQcWltHjkDznEDKNpek,190
+half_orm_dev/templates/warning,sha256=4hlZ_rRdpmkXxOeRoVd9xnXBARYXn95e-iXrD1f2u7k,490
+half_orm_dev-0.16.0a1.dist-info/licenses/AUTHORS,sha256=eWxqzRdLOt2gX0FMQj_wui03Od3jdlwa8xNe9tl84g0,113
+half_orm_dev-0.16.0a1.dist-info/licenses/LICENSE,sha256=ufhxlSi6mttkGQTsGWrEoB3WA_fCPJ6-k07GSVBgyPw,644
+half_orm_dev-0.16.0a1.dist-info/METADATA,sha256=yXk-7V-dH3EH9dOa5YzuGzsxSuGo5k7oj_htbJ3UY6M,10206
+half_orm_dev-0.16.0a1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+half_orm_dev-0.16.0a1.dist-info/entry_points.txt,sha256=qaM6BMXgT4OIIRaIrShZQ_sKlqVIgl8QRHk3h0m3uns,46
+half_orm_dev-0.16.0a1.dist-info/top_level.txt,sha256=M5hEsWfn5Kw0HL-VnNmS6Jw-3cwRyjims5a8cr18eTM,13
+half_orm_dev-0.16.0a1.dist-info/RECORD,,

half_orm_dev-0.16.0a1.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (80.9.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

half_orm_dev-0.16.0a1.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+hop = half_orm_dev.hop:main

half_orm_dev-0.16.0a1.dist-info/licenses/AUTHORS

@@ -0,0 +1,3 @@
+# This is the list of half_orm_dev's significant contributors.
+# Hopefully, it will become larger...
+Joël Maizi

half_orm_dev-0.16.0a1.dist-info/licenses/LICENSE

@@ -0,0 +1,14 @@
+This file is part of half_orm_dev.
+
+half_orm_dev is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+half_orm is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program.  If not, see <http://www.gnu.org/licenses/>.

half_orm_dev-0.16.0a1.dist-info/top_level.txt

@@ -0,0 +1 @@
+half_orm_dev