tina4-python 0.1.57__tar.gz → 0.2.64__tar.gz

{tina4_python-0.1.57 → tina4_python-0.2.64}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.3
 Name: tina4-python
-Version: 0.1.57
+Version: 0.2.64
 Summary: Tina4Python - This is not another framework for Python
 Author: Andre van Zuydam
 Author-email: andrevanzuydam@gmail.com
@@ -9,9 +9,12 @@ Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
-Requires-Dist: Jinja2 (>=3.0.3,<4.0.0)
+Classifier: Programming Language :: Python :: 3.13
+Requires-Dist: Jinja2 (>=3.1.4,<4.0.0)
+Requires-Dist: bcrypt (>=4.1.3,<5.0.0)
 Requires-Dist: cryptography (>=42.0.5,<43.0.0)
 Requires-Dist: libsass (>=0.22.0,<0.23.0)
+Requires-Dist: litequeue (>=0.9,<0.10)
 Requires-Dist: mypy (>=0.991,<0.992)
 Requires-Dist: pyjwt (>=2.8.0,<3.0.0)
 Requires-Dist: python-dotenv (>=1.0.1,<2.0.0)
@@ -56,6 +59,22 @@ If you are developing on Tina4, make sure you copy the public folder from tina4_
 
 ### Installation
 
+Virtual environment
+
+Linux / Mac
+```bash
+python3 -m venv venv
+source ./venv/bin/activate
+pip install poetry
+```
+
+Windows
+```bash
+python -m venv venv
+.\venv\Scripts\activate
+pip install poetry
+```
+
 #### Windows
 
 1.) Install Poetry:
@@ -201,6 +220,16 @@ async def capture_get(request, response):
 @post("/capture")
 async def capture_post(request, response):
     return response(request.body)
+
+@get("/simple")
+async def simple_get(request, response):
+    print("<h1>Hello World!</h1>")
+
+@get("/redirect")
+async def simple_get(request, response):
+    
+    return response.redirect("/test")
+
 ```
 
 In your ```src/__init__.py``` add the following code
@@ -224,33 +253,150 @@ For ease of use you can supply an `API_KEY` param to your .env with a secret of
 API_KEY=somehash
 ```
 
+### Suppressing the default webservice
+
+You may want to use your Tina4 project as a library in another project so suppressing the default webservice is probably needed.
+
+```.env
+TINA4_DEFAULT_WEBSERVER="False"
+```
+or in your `__init__.py` file
+```python
+import os
+os.environ["TINA4_DEFAULT_WEBSERVER"] = "False"
+```
+Additionally, it will require you to rename `src` to the name of your package
 
 ### Features
-| Completed                  | To Do             |
-|----------------------------|-------------------|
-| Python pip package         |                   |
-| Basic environment handling |                   |
-| Basic routing              | OpenAPI (Swagger) |
-| Enhanced routing           |                   |
-| CSS Support                |                   |
-| Image Support              |                   |
-| Localization               |                   |
-| Error Pages                |                   |
-| Template handling          |                   |
-| Form posting               |                   |
-| JWT tokens & security      |                   |
+| Completed                  | To Do |
+|----------------------------|-------|
+| Python pip package         |       |
+| Basic environment handling |       |
+| Routing with Swagger       |       |
+| Enhanced Routing           |       |
+| CSS Support                |       |
+| Image Support              |       |
+| Localization               |       |
+| Error Pages                |       |
+| Template handling          |       |
+| Form posting               |       |
+| Migrations                 |       |
+| Colored Debugging          |       |
+| Database Abstraction       |       |   
+
+### Database
+
+```bash
+
+Various databases initialised:
+
+dba = Database("sqlite3:test.db", "username", "password")
+dba = Database("mysql:localhost/3306:myschema", "username", "password")
+dba = Database("postgres:localhost/5432:myschema", "username", "password")
+dba = Database("firebird:localhost/3050:/home/database/FIREBIRD.FDB", "username", "password")
+
+NoSQL support (Still to be developed):
+
+dba = Database("mongodb:localhost/27017:mycollection", "username", "password")
+dba = Database("firebase:https://your_storage.firebaseio.com", "username", "password")
+
+Fetching records and passing data as parameters, limit and skip specified:
+
+records = dba.fetch("select * from table where something = ? and something2 = ?", params=["something", "something2"], limit=10, skip=5)
+
+print (records)
+print (records.to_json())
+{
+  id : 1
+  something: "something",
+  something2: "something2"
+}
+
+print(records[0].id)
+1
+
+record = dba.fetch_one("select * from table where something = ? and something2 = ?", params=["something", "something2"])
+
+print(record.id)
+
+print (records.to_json())
+1
+
+
+Executing sql queries:
+
+dba.execute ("update table set something = ? and something2 = ? where id = ?", params=["something", "something2", 1])
+dba.execute ("delete from table where id = ?", params=[1])
+
+
+Starting a transaction:
+
+dba.start_transaction()
+
+
+Rollback a transaction:
+
+dba.roll_back()
+
+
+Commit a transaction:
+
+dba.commit()
+
+
+Select method (Still in development):
+
+dba.select(["id", "something", "something2"], "table_name", filter={"id": 1}, limit=10, skip=0)
+dba.select(["id", "something", "something2"], "table_name", filter=[{"id": 1}, {"id": 2}], limit=10, skip=0)
+dba.select(["id", "something", "sum(id)"])
+   .from(["table"])
+   .join(["tabel2"])
+   .on([""])
+   .and([{"id": 1}])
+   .where({"id" : 2}, "id = ?", [{"id": 2}])
+   .having()
+   .group_by()
+   .order_by(["id"])
+
+
+Updating records - records will be found by primary key specified and then updated:
+
+dba.update(table_name="table_name", records.fromJSON(json_string))
+dba.update(table_name="table_name", records, primary_key="id")
+dba.update(table_name="table_name", record, primary_key="id") # primary key implied by first key value pair
+
+
+Inserting records - pass a dictionary for a single record and a list of dictionaries for multiple records:
+
+dba.insert(table_name="table_name", dba.from_json(json_string))
+dba.insert(table_name="table_name", {"id": 1, "something": "hello", "something2": "world"})
+dba.insert(table_name="table_name", [{"id": 1, "something": "hello", "something2": "world"}, 
+{"id": 2, "something": "hello2", "something2": "world2"}])
+
+
+Deleting records - specify table name. Records can either be found by primary key or filter:
+
+dba.delete("table_name", record, primary_key="id")
+dba.delete("table_name", filter={"id": 1})
+dba.delete("table_name", filter=[{"id": 1}, {"id": 2}])
+
+Migration updates:
+
+   - record count added
+   - Database result object updated
+```
 
 ### Building and Deployment
 
 #### Using Python
 
-Building the package:
- ```bash
+Building the package without poetry - you will need to request an API key:
+```bash
 python3 -m pip install --upgrade build
 python3 -m build
 python3 -m pip install --upgrade twine
 python3 -m twine upload dist/*
- ```
+```
 
 #### Using Poetry
 
@@ -276,3 +422,13 @@ Flake8 Code tests
 poetry run flake8 ./tina4_python
 ```
 
+### Using queues
+
+```bash
+docker run -d --hostname=my-kafka --name=some-kafka -p 9092:9092 apache/kafka
+```
+
+```bash
+docker run -d --hostname=my-rabbit --name=some-rabbit -p 15672:15672 -p 5672:5672 rabbitmq:3
+```
+