tina4-python 0.2.122__py3-none-any.whl

tina4_python/translations/fr/LC_MESSAGES/messages.po

@@ -0,0 +1,84 @@
+# French translations for PROJECT.
+# Copyright (C) 2024 ORGANIZATION
+# This file is distributed under the same license as the PROJECT project.
+# FIRST AUTHOR <EMAIL@ADDRESS>, 2024.
+#
+msgid ""
+msgstr ""
+"Project-Id-Version: PROJECT VERSION\n"
+"Report-Msgid-Bugs-To: EMAIL@ADDRESS\n"
+"POT-Creation-Date: 2024-02-14 18:17+0200\n"
+"PO-Revision-Date: 2024-02-14 18:17+0200\n"
+"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
+"Language: fr\n"
+"Language-Team: fr <LL@li.org>\n"
+"Plural-Forms: nplurals=2; plural=(n > 1);\n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=utf-8\n"
+"Content-Transfer-Encoding: 8bit\n"
+"Generated-By: Babel 2.13.1\n"
+
+#: Messages.py:5
+msgid "Debug: {message}"
+msgstr "Débogage : {message}"
+
+#: Messages.py:6
+msgid "Warning: {message}"
+msgstr "Avertissement : {message}"
+
+#: Messages.py:7
+msgid "Error: {message}"
+msgstr "Erreur : {message}"
+
+#: Messages.py:8
+msgid "Info: {message}"
+msgstr "Info : {message}"
+
+#: Messages.py:12
+msgid "Matching: {matching}"
+msgstr "Correspondance : {matching}"
+
+#: Messages.py:13
+msgid "Variables: {variables}"
+msgstr "Variables : {variables}"
+
+#: Messages.py:14
+msgid "Root Path {root_path} {url}"
+msgstr "Chemin racine : {root_path} {url}"
+
+#: Messages.py:15
+msgid "Attempting to serve static file: {static_file}"
+msgstr "Tentative de servir le fichier statique : {static_file}"
+
+#: Messages.py:16
+msgid "Attempting to serve CSS file: {css_file}"
+msgstr "Tentative de servir le fichier CSS : {css_file}"
+
+#: Messages.py:17
+msgid "Attempting to serve image file: {image_file}"
+msgstr "Tentative de servir le fichier image : {image_file}"
+
+#: __init__.py:15
+msgid "Assuming root path: {root_path}, library path: {library_path}"
+msgstr "Hypothèse chemin racine : {root_path}, chemin bibliothèque : {library_path}"
+
+#: __init__.py:16
+msgid "Load all things"
+msgstr "Charger tout"
+
+#: __init__.py:17
+msgid "Server started http://{host_name}:{port}"
+msgstr "Serveur démarré http://{host_name}:{port}"
+
+#: __init__.py:18
+msgid "Server stopped."
+msgstr "Serveur arrêté."
+
+#: __init__.py:19
+msgid "Starting webserver on {port}"
+msgstr "Démarrage du serveur web sur {port}"
+
+#: __init__.py:20
+msgid "Entry point name ... {name}"
+msgstr "Nom du point d'entrée... {name}"
+

tina4_python-0.2.122.dist-info/METADATA

@@ -0,0 +1,465 @@
+Metadata-Version: 2.4
+Name: tina4-python
+Version: 0.2.122
+Summary: Tina4Python - This is not another framework for Python
+Author-email: Andre van Zuydam <andrevanzuydam@gmail.com>
+Requires-Python: <4.0,>=3.12
+Requires-Dist: asyncer>=0.0.8
+Requires-Dist: bcrypt<5.0.0,>=4.2.1
+Requires-Dist: cryptography<45.0.0,>=44.0.0
+Requires-Dist: hypercorn<0.18.0,>=0.17.3
+Requires-Dist: jinja2<4.0.0,>=3.1.5
+Requires-Dist: libsass<0.24.0,>=0.23.0
+Requires-Dist: litequeue<0.10,>=0.9
+Requires-Dist: pyjwt<3.0.0,>=2.10.1
+Requires-Dist: python-dotenv<2.0.0,>=1.0.1
+Requires-Dist: simple-websocket<2.0.0,>=1.1.0
+Requires-Dist: watchdog<7.0.0,>=6.0.0
+Description-Content-Type: text/markdown
+
+### Tina4Python - This is not a framework for Python
+
+Tina4Python is a light-weight routing and twig based templating system based on the [Tina4](https://github.com/tina4stack/tina4-php) stack which allows you to write websites and API applications very quickly.
+.
+### System Requirements
+
+- Install UV
+
+Linux
+```bash
+curl -LsSf https://astral.sh/uv/install.sh | sh
+```
+
+Windows
+```bash
+powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"
+```
+
+Lock down a specific Python version
+```bash
+uv python pin 3.13
+```
+
+- Install Jurigged (Enables Hot Reloading):
+```bash
+uv pip install jurigged
+```
+
+### Quick Start
+
+Our package management is moving to UV, the following is enough to get started once uv has been installed.
+See here https://docs.astral.sh/uv/getting-started/installation/
+```bash
+uv add tina4_python
+```
+
+Poetry should still work as follows
+```bash
+poetry new project-name
+cd project-name
+poetry add tina4_python
+poetry add jurigged
+```
+Create an entry point for Tina4 called ```app.py``` and add the following to the file
+```python
+from tina4_python import *
+```
+
+### Overview
+The basic tina4 project uses an autoloader methodology from the src folder
+All the source folders you should need are created there and they are run from __init__.py
+
+If you are developing on Tina4, make sure you copy the public folder from tina4_python into src
+
+### 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:
+```powershell
+(Invoke-WebRequest -Uri https://install.python-poetry.org -UseBasicParsing).Content | py -
+```
+
+2.) Add the following path to the system PATH:
+```
+%APPDATA%\pypoetry\venv\Scripts
+```
+
+3.) Install Tina4Python and Jurigged:
+```bash
+poetry add tina4_python
+poetry add jurigged
+```
+
+**or**
+
+```bash
+pip install tina4_python
+pip install jurigged
+```
+
+### Usage
+
+After defining templates and routes, run the Tina4Python server:
+
+- **Normal Server**:
+```bash
+poetry run python app.py
+```
+
+- **Server with Hot Reloading**:
+```bash
+poetry run jurigged app.py
+```
+
+- **Server on a Specific Port**:
+```bash
+poetry run python app.py 7777
+```
+
+- **Server to not autostart **:
+```bash
+poetry run python app.py manual
+```
+  
+- **Server with alternate language** (for example fr = French):
+```bash
+poetry run python app.py fr
+```
+
+Add more translations by going [here](TRANSLATIONS.md)
+
+### Templating
+Tina4 uses Jinja2 (Twig) templating to provide a simple and efficient way to create web pages.
+
+1.) **Twig Files**: Add your Twig files within the `src/templates` folder. For instance, you might create files like `index.twig`, `base.twig`, etc., containing your HTML structure with Twig templating syntax for dynamic content.
+
+2.) **Using Twig**: In these Twig files, you can use Twig syntax to embed dynamic content, control structures, variables, and more. For example:
+
+```twig
+<!-- index.twig -->
+<!DOCTYPE html>
+<html>
+<head>
+    <title>Welcome</title>
+</head>
+<body>
+    <h1>Hello, {{ name }}!</h1>
+</body>
+</html>
+```
+
+### Defining Routes
+
+
+The routing in Tina4Python can be defined in the `__init__.py` file or any file used as an entry point to your application. Tina4Python provides decorators to define routes easily.
+
+1.) **Creating Routes**: Define routes using decorators from Tina4Python to handle HTTP requests.
+
+Example:
+```python
+from tina4_python.Router import get
+from tina4_python.Response import Response
+@get("/hello")
+async def hello(request, response):
+  return response("Hello, World!")
+```
+
+This code creates a route for a GET request to `/hello`, responding with "Hello, World!".
+
+2.) **Route Parameters**: You can define route parameters by enclosing variables with curly braces { }. The parameters are passed to the function as arguments.
+
+ Example:
+```python
+from tina4_python.Router import get
+from tina4_python.Response import Response
+
+@get("/hello/{name}")
+async def greet(**params): #(request, response)
+   name = params['request'].params['name']
+   return params['response'](f"Hello, {name}!") # return response()
+````
+
+This code creates a route for a GET request to `/hello/{name}`, where `name` is a parameter in the URL. The function `greet` accepts this parameter and responds with a personalized greeting.
+
+Example:
+- Visiting `/hello/John` will respond with "Hello, John!"
+- Visiting `/hello/Alice` will respond with "Hello, Alice!"
+
+3.) POST routes now require jwt token or API key to validate requests with an Authorization header
+```
+Authorization: Bearer <token>
+```
+You can generate tokens using tina4_python.tina4_auth which takes in a payload parameter which is a dictionary:
+#### Example of a post with a form, assume the route is ```/capture```
+
+You need the following twig file in the ```src/templates``` folder called ```something.twig```
+
+```twig something.twig
+<form method="post">
+    <input name="email" type="text" placeholder="Email">
+    <button type="submit">Send</button>
+    <input type="hidden" name="formToken" value="{{ token }}" >
+</form>
+```
+
+You can add the following code to ```src/routes/example.py```
+
+```python
+# get router which renders the twig form html
+@get("/capture")
+async def capture_get(request, response):
+    # get a token to add to the form
+    token = tina4_python.tina4_auth.get_token({"data": {"formName": "capture"}})
+    html = Template.render_twig_template("somefile.twig", {"token": token})
+    return response(html)
+
+# returns back to the user the form data that has been posted
+@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
+
+```python
+from .routes.example import *
+```
+Generate tokens with the following code as per the example above, tokens carry a payload and we add an additional ```expires``` value to the token based on the env variable ```TINA4_TOKEN_LIMIT``` 
+
+```python
+import tina4_python
+
+tina4_python.tina4_auth.get_token({"data": {"something":"more"}})
+```
+
+OR 
+
+For ease of use you can supply an `API_KEY` param to your .env with a secret of your choice to use:
+
+```dotenv
+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 |       |
+| 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")
+# mssql
+brew install FreeTDS 
+export LDFLAGS="-L/opt/homebrew/lib -L/opt/homebrew/opt/openssl/lib"
+export CFLAGS="-I/opt/homebrew/include"
+export CPPFLAGS="-I/opt/homebrew/opt/openssl@3/include"
+poetry run pip uninstall pymssql -y
+poetry run pip install pymssql==2.3.2 --no-binary :all:
+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 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
+
+Building the package:
+```bash
+poetry build
+```
+
+Publishing the package:
+```bash
+poetry publish
+```
+
+#### Running tests & checks
+
+PyTests
+```
+uv run pytest ./tests --verbose
+```
+
+Flake8 Code tests
+```
+uv 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
+```
+
+## Websocket Testing
+
+```bash
+brew install websocat
+```
+
+```python
+websocat http://localhost:7145/websocket
+```
+
+

tina4_python-0.2.122.dist-info/RECORD

@@ -0,0 +1,47 @@
+tina4_python/Auth.py,sha256=W_erOFDc9wTF9G6mWkucMT5Xbf28bfXw8YPnXxcArvQ,7887
+tina4_python/Constant.py,sha256=s9R_X7Ok5h80eWVGFyhs9IycYoDCobLVtomDkdAwnfA,1280
+tina4_python/Database.py,sha256=c-aeWg5D-oTEruUL0FYEnef-3n5ad12nFieDFCm1qqU,24615
+tina4_python/DatabaseResult.py,sha256=L29NPO86gp6BjSDmiwSPN7Cp_vb_wXuPeM8SmwWyBQo,3277
+tina4_python/DatabaseTypes.py,sha256=5SJDThyOmQpLNnPDAqjKASLWvJeGWcwXqIdfafGnVY4,582
+tina4_python/Debug.py,sha256=Mc4I8_T204dTF534U1SApMiEMrviGJSCdvkhlTzORuU,4186
+tina4_python/Env.py,sha256=OLO1vRyEyRYZ0IIEpLFZoKoA089BkGr6K1KS0XCtxoM,1359
+tina4_python/Localization.py,sha256=2PBY02TN6G45L7WyjlmC70rOHWYTtNvQGeOErXmD0os,1288
+tina4_python/Messages.py,sha256=g2aCY9fMfo1vdKley2pMYODZMYCDuITrVNV_Ts1nCNI,1121
+tina4_python/MiddleWare.py,sha256=tJwXLSeGe30t-xt3QCmZHGzdPN9lCUICE_AWHGigRgQ,2876
+tina4_python/Migration.py,sha256=sZVD1TGQEyGZjoVOKY4iefxBS7AN5LSkHw5CZ1rePUc,5874
+tina4_python/ORM.py,sha256=sW0WYwO8LgYNfjdw5llZGcZqjSM9A8dID8G2cSVmZpI,22737
+tina4_python/Queue.py,sha256=81tFj4mqXOjrow3DkBPpYC2U7SDHLuHSnzAX8XHNUVM,23772
+tina4_python/Request.py,sha256=1QasnLPIqA0aLtGhhzXxaqrDoSj83taq_Xn6lcsx_5E,358
+tina4_python/Response.py,sha256=msXkxgcrQ8HGF0ZwmD8P1XVOLcOV0ee5gvTjnKvPz2s,4116
+tina4_python/Router.py,sha256=xs3R6hWMQTWrsde7lEMfozbFTyMpnfabWAIil7PUcqk,17368
+tina4_python/Session.py,sha256=Bxufjc0mTOZZZ5vrhTymmgsF3doKnyAKwU_HWFbhLv4,10756
+tina4_python/ShellColors.py,sha256=oVT8X2QWiROo6bakhPQyJhspiRf39bmfsmiXIaf9lwI,561
+tina4_python/Swagger.py,sha256=PdFeWEyMfxrH9Nf-C_Mip6tpqEx8Fp5BZ1I8W3RUYug,7901
+tina4_python/Template.py,sha256=T0R2erPq9gOyewYDLmYOMZr9HI564ueZXSWJfiVEdZk,4155
+tina4_python/Webserver.py,sha256=WadlQ14e6SeJ_j7jrmKJyYUv9ulJFOrU-f43KG37tgI,19431
+tina4_python/Websocket.py,sha256=dtbdBy4nJpXXrzLrlkoKVXRjOH1DDYxORsNFGd3WidA,1661
+tina4_python/__init__.py,sha256=WScgfON9aucirmjqXyLR_qqRwKMo-OFFoDzisxTVF7E,15394
+tina4_python/messages.pot,sha256=pSnLUe3YcYBz35ofTDc4-I2_vL2Qxt1rzkQkyu5r5Rc,1740
+tina4_python/public/favicon.ico,sha256=KHunJ9o9DHIIAkiE1l2dwh8Zuy97sKZK2FoiH8KJSOg,15406
+tina4_python/public/css/readme.md,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+tina4_python/public/images/403.png,sha256=9m1IvR-LN6Y3fSA1um5xtjCUUzyHXZrJxFQRw614iA8,51321
+tina4_python/public/images/404.png,sha256=6HAjf1QAXaTJRZA0YWP04hzQfI1m8PKugvgshxm7yKM,49297
+tina4_python/public/images/500.png,sha256=ZtccQ0aXGBi6L5B86nR7KuMHx3Jw7_M4yCMcWXaYBu8,36786
+tina4_python/public/images/logo.png,sha256=kBqTc-8FXQ0P8eTZGrQqRHw9V3gQ3q5Q_aenR0vOp1k,111876
+tina4_python/public/images/readme.md,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+tina4_python/public/js/readme.md,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+tina4_python/public/js/reconnecting-websocket.js,sha256=fT4QA6FVNHuQtaTg9tK4a2nz7ov8gG2HNM0f0LlYYPw,14803
+tina4_python/public/js/tina4helper.js,sha256=qSJ_EfIaJIK5L95EVntifoD1UW8csb86S7WjMTGjdbc,12647
+tina4_python/public/swagger/index.html,sha256=eo481GzSvIHcsj_EEQfd2xFXeOu2j-hFwQ0LvbgS0gU,4221
+tina4_python/public/swagger/oauth2-redirect.html,sha256=sVjX7irkm-qMcYn5beDVeRCHgRf4QGm6ZThwTRUg0bA,2109
+tina4_python/templates/readme.md,sha256=DIwkobj8Kn49ktegNLvEZjTud-NvPcQ5f5ZACRV_AyI,53
+tina4_python/templates/errors/403.twig,sha256=2XRQeVTyxy7oZa4gg0HNi-sqHIrxzXghnS7THV8lD8w,344
+tina4_python/templates/errors/404.twig,sha256=hY-8aOOP1E6-2EVoCrNtdM0B36wcbu77iZRDCNLkKo0,323
+tina4_python/templates/errors/500.twig,sha256=4uVhgGSiSU5AX2c2Tm1PWEzjpCzFr_yrkwr4BOIUMEQ,343
+tina4_python/translations/en/LC_MESSAGES/messages.mo,sha256=gHsTU2alg9etySBq0eGIu_SzseY35JFpg0NPpn18ebU,1633
+tina4_python/translations/en/LC_MESSAGES/messages.po,sha256=DZWTsJvlyFFNDVQ_OPM54_tmRYkaE5GFIYobWjq_WUU,2374
+tina4_python/translations/fr/LC_MESSAGES/messages.mo,sha256=gIZc1BLprTBKfYG0aU6DaGWBlpTdv60UFblCtvP39jo,1715
+tina4_python/translations/fr/LC_MESSAGES/messages.po,sha256=KmvGCKNQfHw_NrTpeRtBKNWZ8hZar1RO5gn-EuDsNcs,2320
+tina4_python-0.2.122.dist-info/METADATA,sha256=Qs2G4-qpMJoX22sC2dszYJGDIPeskXq2M9Ijg8kpOLs,12186
+tina4_python-0.2.122.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+tina4_python-0.2.122.dist-info/RECORD,,

tina4_python-0.2.122.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.27.0
+Root-Is-Purelib: true
+Tag: py3-none-any