asok 0.1.0__tar.gz

asok-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Asok Framework Contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

asok-0.1.0/MANIFEST.in

@@ -0,0 +1,5 @@
+recursive-include asok/admin/templates *.html
+recursive-include asok/admin/static *
+recursive-include asok/assets *
+recursive-include asok/api/templates *.html
+recursive-include asok/api/static *

asok-0.1.0/PKG-INFO

@@ -0,0 +1,209 @@
+Metadata-Version: 2.4
+Name: asok
+Version: 0.1.0
+Summary: A minimalist, zero-dependency Python web framework.
+Author-email: Asok Maintainers <asok-framework@outlook.com>
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/asok-framework/asok
+Project-URL: Repository, https://github.com/asok-framework/asok
+Project-URL: Issues, https://github.com/asok-framework/asok/issues
+Keywords: web,framework,zero-dependency,minimalist,orm,wsgi
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Operating System :: OS Independent
+Classifier: Topic :: Internet :: WWW/HTTP :: WSGI :: Application
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+
+# <img src="icons/favicon.svg" alt="Asok Framework Logo" width="50" align="center" /> Asok Framework
+
+**Asok** is a powerful and elegant "zero-dependency" Python micro-framework. Version 0.1.0 introduces a professional modular architecture, file-based routing through the `src/pages/` directory, and a comprehensive CLI tool.
+
+📖 **[→ Full Documentation](docs/README.md)** — 44 chapters, from installation to production deployment.
+
+---
+
+## ✨ Key Features
+- **Zero Dependencies**: Relies exclusively on the Python standard library.
+- **Professional Typing**: Full support for PEP 484 type hints for a robust developer experience.
+- **Modular Package**: Install via `pip` or by simply dropping the `asok/` folder into your project.
+- **CLI Tool**: Scaffolding (`asok make`), Dev Server (`asok dev`), and assets management.
+- **Local Geolocation**: Built-in IP detection and localization without third-party APIs.
+- **File-based Routing**: Your `src/pages/` directories define your URLs.
+- **Dynamic Routing**: Native support for parameters via `[param]`.
+- **Built-in Authentication**: Secure sessions via signed cookies (HMAC).
+- **AsokDB**: A mini SQLite ORM with relationships and automatic hashing.
+- **Template Engine**: Jinja-like syntax with inheritance (`extends`) and blocks.
+
+---
+
+## ⚖️ Asok vs Django vs Flask
+
+Asok was designed to bring the best of both worlds (the lightweight nature of Flask and the batteries-included approach of Django), while adding modern file-based routing (inspired by Next.js/SvelteKit).
+
+| Feature | Asok | Flask | Django |
+|---|---|---|---|
+| **External Dependencies** | **0 (Zero)** | ~6 (Werkzeug, Jinja...) | ~3 (asgiref, sqlparse...) |
+| **Philosophy** | Batteries Included + Modern | Micro-framework | Megalo-framework |
+| **Routing System** | **File-based** (`src/pages/`) | Decorators (`@app.route`) | Centralized (`urls.py`) |
+| **Built-in ORM** | Yes (AsokDB - optimized SQLite) | No (SQLAlchemy required) | Yes (Full-featured, multi-DB) |
+| **Generated Admin** | Yes, 100% automatic and reactive | No (Flask-Admin required) | Yes, historical and heavy |
+| **Real-time (WebSockets)** | **Native** (Alive Engine) | No (Flask-SocketIO required) | Complex (Django Channels) |
+| **Reactive Components** | **Native** (Live Components) | No | No |
+| **Ideal for** | Fast projects, Modern SaaS, Zero devops | Simple APIs, Microservices | Large legacy architectures |
+
+---
+
+## 🛠️ Installation & Setup
+
+### 1. Installation
+You can install Asok via pip (coming soon) or clone the repo and use the `asok/` folder.
+
+### 2. Create a project
+```bash
+asok create my-project
+cd my-project
+```
+
+### 3. Start the server
+```bash
+asok dev
+```
+
+---
+
+## 🏗️ Project Structure
+```text
+.
+├── wsgi.py            # Application entry point
+├── src
+│   ├── locales/       # JSON translations (en.json, fr.json)
+│   ├── middlewares/   # Request interceptors
+│   ├── models/        # ORM models (Post.py, User.py)
+│   ├── pages/         # YOUR ROUTES (page.py or page.html)
+│   │   ├── page.html  # Route /
+│   │   └── about/
+│   │       └── page.html # Route /about
+│   └── partials/      # Shared resources
+│       ├── css/, js/, images/
+│       └── html/      # Layouts and components
+```
+
+---
+
+## 🛣️ Routing
+Routing is dictated by the structure of the `src/pages/` folder. Each folder represents a URL segment, and contains a `page.py` or `page.html` file.
+
+- `src/pages/page.html` → `/`
+- `src/pages/about/page.html` → `/about`
+- `src/pages/user/[id]/page.py` → `/user/123` (`id` parameter)
+
+### Dynamic Page Example (`src/pages/shop/[cat]/page.py`)
+```python
+def render(request):
+    category = request.params.get('cat')
+    return f"Shop : {category}"
+```
+
+---
+
+## 🎨 Templates & Inheritance
+Templates in `src/pages/` can inherit from layouts in `src/partials/html/`.
+
+**Layout (`src/partials/html/main.html`)** :
+```html
+<html>
+<body>
+    {% include 'html/_nav.html' %}
+    <main>{% block content %}{CONTENT}{% endblock %}</main>
+</body>
+</html>
+```
+
+**Page (`src/pages/page.html`)** :
+```html
+{% extends 'html/main.html' %}
+{% block content %}
+    <h1>Welcome to Asok V2</h1>
+{% endblock %}
+```
+
+---
+
+## 🗄️ AsokDB (The ORM)
+Define your models in `src/models/`.
+
+```python
+from asok import Model, Field, Relation
+
+class User(Model):
+    name = Field.String()
+    email = Field.String(unique=True)
+    password = Field.Password()
+    posts = Relation.HasMany('Post')
+```
+
+---
+
+## 🌍 i18n & Validation
+- **Translation**: `{{ __('welcome') }}` (looks in `src/locales/`).
+- **Validation**: `Validator(data).rule('email', 'required|email')`.
+- **CSRF**: `{{ request.csrf_input() }}` automatic in forms.
+
+---
+
+## 🎨 Admin Customization
+
+The administration interface is highly customizable:
+
+```python
+admin = Admin(app, site_name="My Platform", favicon="images/logo.svg")
+```
+
+### Asset Resolution (Smart Resolution)
+The admin automatically detects the source of resources:
+- **Internal Assets**: Files like `admin.css` or the default `logo.svg` are served from the package.
+- **Project Assets**: If you specify a path (e.g. `images/logo.svg` or `uploads/icon.png`), the admin will serve them from your resources folder (`src/partials/`).
+
+---
+
+## 🚀 Towards Production
+Asok is WSGI compatible. You can use Gunicorn or any other WSGI server:
+```bash
+gunicorn wsgi:app
+```
+
+---
+
+## 🤝 Contributing
+Contributions are more than welcome! Asok is built to be simple and transparent, making it a great codebase to dive into.
+- Found a bug? Open an **Issue**.
+- Have a feature idea? Start a **Discussion**.
+- Fixed something? Submit a **Pull Request**.
+
+Make sure to run the tests and linter before submitting your PR:
+```bash
+make lint
+make test
+```
+
+---
+
+## 📜 License
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+
+<br><br>
+<p align="left">
+  <img src="icons/logo.svg" alt="Asok Framework" width="200" />
+</p>
+
+

asok-0.1.0/README.md

@@ -0,0 +1,183 @@
+# <img src="icons/favicon.svg" alt="Asok Framework Logo" width="50" align="center" /> Asok Framework
+
+**Asok** is a powerful and elegant "zero-dependency" Python micro-framework. Version 0.1.0 introduces a professional modular architecture, file-based routing through the `src/pages/` directory, and a comprehensive CLI tool.
+
+📖 **[→ Full Documentation](docs/README.md)** — 44 chapters, from installation to production deployment.
+
+---
+
+## ✨ Key Features
+- **Zero Dependencies**: Relies exclusively on the Python standard library.
+- **Professional Typing**: Full support for PEP 484 type hints for a robust developer experience.
+- **Modular Package**: Install via `pip` or by simply dropping the `asok/` folder into your project.
+- **CLI Tool**: Scaffolding (`asok make`), Dev Server (`asok dev`), and assets management.
+- **Local Geolocation**: Built-in IP detection and localization without third-party APIs.
+- **File-based Routing**: Your `src/pages/` directories define your URLs.
+- **Dynamic Routing**: Native support for parameters via `[param]`.
+- **Built-in Authentication**: Secure sessions via signed cookies (HMAC).
+- **AsokDB**: A mini SQLite ORM with relationships and automatic hashing.
+- **Template Engine**: Jinja-like syntax with inheritance (`extends`) and blocks.
+
+---
+
+## ⚖️ Asok vs Django vs Flask
+
+Asok was designed to bring the best of both worlds (the lightweight nature of Flask and the batteries-included approach of Django), while adding modern file-based routing (inspired by Next.js/SvelteKit).
+
+| Feature | Asok | Flask | Django |
+|---|---|---|---|
+| **External Dependencies** | **0 (Zero)** | ~6 (Werkzeug, Jinja...) | ~3 (asgiref, sqlparse...) |
+| **Philosophy** | Batteries Included + Modern | Micro-framework | Megalo-framework |
+| **Routing System** | **File-based** (`src/pages/`) | Decorators (`@app.route`) | Centralized (`urls.py`) |
+| **Built-in ORM** | Yes (AsokDB - optimized SQLite) | No (SQLAlchemy required) | Yes (Full-featured, multi-DB) |
+| **Generated Admin** | Yes, 100% automatic and reactive | No (Flask-Admin required) | Yes, historical and heavy |
+| **Real-time (WebSockets)** | **Native** (Alive Engine) | No (Flask-SocketIO required) | Complex (Django Channels) |
+| **Reactive Components** | **Native** (Live Components) | No | No |
+| **Ideal for** | Fast projects, Modern SaaS, Zero devops | Simple APIs, Microservices | Large legacy architectures |
+
+---
+
+## 🛠️ Installation & Setup
+
+### 1. Installation
+You can install Asok via pip (coming soon) or clone the repo and use the `asok/` folder.
+
+### 2. Create a project
+```bash
+asok create my-project
+cd my-project
+```
+
+### 3. Start the server
+```bash
+asok dev
+```
+
+---
+
+## 🏗️ Project Structure
+```text
+.
+├── wsgi.py            # Application entry point
+├── src
+│   ├── locales/       # JSON translations (en.json, fr.json)
+│   ├── middlewares/   # Request interceptors
+│   ├── models/        # ORM models (Post.py, User.py)
+│   ├── pages/         # YOUR ROUTES (page.py or page.html)
+│   │   ├── page.html  # Route /
+│   │   └── about/
+│   │       └── page.html # Route /about
+│   └── partials/      # Shared resources
+│       ├── css/, js/, images/
+│       └── html/      # Layouts and components
+```
+
+---
+
+## 🛣️ Routing
+Routing is dictated by the structure of the `src/pages/` folder. Each folder represents a URL segment, and contains a `page.py` or `page.html` file.
+
+- `src/pages/page.html` → `/`
+- `src/pages/about/page.html` → `/about`
+- `src/pages/user/[id]/page.py` → `/user/123` (`id` parameter)
+
+### Dynamic Page Example (`src/pages/shop/[cat]/page.py`)
+```python
+def render(request):
+    category = request.params.get('cat')
+    return f"Shop : {category}"
+```
+
+---
+
+## 🎨 Templates & Inheritance
+Templates in `src/pages/` can inherit from layouts in `src/partials/html/`.
+
+**Layout (`src/partials/html/main.html`)** :
+```html
+<html>
+<body>
+    {% include 'html/_nav.html' %}
+    <main>{% block content %}{CONTENT}{% endblock %}</main>
+</body>
+</html>
+```
+
+**Page (`src/pages/page.html`)** :
+```html
+{% extends 'html/main.html' %}
+{% block content %}
+    <h1>Welcome to Asok V2</h1>
+{% endblock %}
+```
+
+---
+
+## 🗄️ AsokDB (The ORM)
+Define your models in `src/models/`.
+
+```python
+from asok import Model, Field, Relation
+
+class User(Model):
+    name = Field.String()
+    email = Field.String(unique=True)
+    password = Field.Password()
+    posts = Relation.HasMany('Post')
+```
+
+---
+
+## 🌍 i18n & Validation
+- **Translation**: `{{ __('welcome') }}` (looks in `src/locales/`).
+- **Validation**: `Validator(data).rule('email', 'required|email')`.
+- **CSRF**: `{{ request.csrf_input() }}` automatic in forms.
+
+---
+
+## 🎨 Admin Customization
+
+The administration interface is highly customizable:
+
+```python
+admin = Admin(app, site_name="My Platform", favicon="images/logo.svg")
+```
+
+### Asset Resolution (Smart Resolution)
+The admin automatically detects the source of resources:
+- **Internal Assets**: Files like `admin.css` or the default `logo.svg` are served from the package.
+- **Project Assets**: If you specify a path (e.g. `images/logo.svg` or `uploads/icon.png`), the admin will serve them from your resources folder (`src/partials/`).
+
+---
+
+## 🚀 Towards Production
+Asok is WSGI compatible. You can use Gunicorn or any other WSGI server:
+```bash
+gunicorn wsgi:app
+```
+
+---
+
+## 🤝 Contributing
+Contributions are more than welcome! Asok is built to be simple and transparent, making it a great codebase to dive into.
+- Found a bug? Open an **Issue**.
+- Have a feature idea? Start a **Discussion**.
+- Fixed something? Submit a **Pull Request**.
+
+Make sure to run the tests and linter before submitting your PR:
+```bash
+make lint
+make test
+```
+
+---
+
+## 📜 License
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+
+<br><br>
+<p align="left">
+  <img src="icons/logo.svg" alt="Asok Framework" width="200" />
+</p>
+
+

asok-0.1.0/asok/__init__.py

@@ -0,0 +1,38 @@
+import os
+import sys
+
+__version__ = "0.1.0"
+
+# Disable bytecode generation (__pycache__) by default to keep the file-system based routing clean.
+# Can be overridden by setting ASOK_WRITE_BYTECODE=true in the environment.
+if os.environ.get("ASOK_WRITE_BYTECODE", "").lower() != "true":
+    sys.dont_write_bytecode = True
+
+from .admin import Admin as Admin
+from .api import api as api
+from .background import background as background
+from .cache import Cache as Cache
+from .component import Component as Component
+from .core import Asok as Asok
+from .exceptions import RedirectException as RedirectException
+from .forms import Form as Form
+from .logger import RequestLogger as RequestLogger
+from .logger import get_logger as get_logger
+from .mail import Mail as Mail
+from .utils.security import internal_only as internal_only
+from .orm import Field as Field
+from .orm import Model as Model
+from .orm import ModelError as ModelError
+from .orm import Relation as Relation
+from .orm import slugify as slugify
+from .ratelimit import RateLimit as RateLimit
+from .request import Request as Request
+from .request import UploadedFile as UploadedFile
+from .scheduler import schedule as schedule
+from .session import Session as Session
+from .session import SessionStore as SessionStore
+from .templates import render_template_string as render_template_string
+from .testing import TestClient as TestClient
+from .validation import Schema as Schema
+from .validation import Validator as Validator
+from .ws import WebSocketServer as WebSocketServer