proper 0.1.dev3__tar.gz → 0.2__tar.gz

proper-0.2/PKG-INFO

@@ -0,0 +1,131 @@
+Metadata-Version: 2.1
+Name: proper
+Version: 0.2
+Summary: A web framework optimized for programmer happiness
+Author-email: Juan-Pablo Scaletti <juanpablo@jpscaletti.com>
+License: Copyright (c) 2019 Juan-Pablo Scaletti
+        
+        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.
+        
+Project-URL: homepage, https://proper.scaletti.dev/
+Project-URL: repository, https://github.com/jpsca/proper
+Project-URL: documentation, https://proper.scaletti.dev/
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Web Environment
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+Requires-Dist: inflection>=0.5.1
+Requires-Dist: isort>=5.0
+Requires-Dist: itsdangerous>=1.1
+Requires-Dist: jinjax>=0.30
+Requires-Dist: mailshake
+Requires-Dist: markupsafe>=2.0
+Requires-Dist: passlib>=1.7
+Requires-Dist: peewee>=3.15
+Requires-Dist: peewee-migrate<2,>=1.12.1
+Requires-Dist: proper-cli>=1.2
+Requires-Dist: tomlkit>=0.12.4
+Requires-Dist: traceback-with-variables==2.0.4
+Requires-Dist: uwsgi>=2.0
+Provides-Extra: dev
+Requires-Dist: ipdb>=0.13; extra == "dev"
+Requires-Dist: pyright>=1.1; extra == "dev"
+Requires-Dist: pre-commit; extra == "dev"
+Requires-Dist: ruff>=0.2.0; extra == "dev"
+Provides-Extra: test
+Requires-Dist: pytest>=7.2; extra == "test"
+Requires-Dist: pytest-cov; extra == "test"
+Requires-Dist: tox; extra == "test"
+Requires-Dist: image-processing-egg; extra == "test"
+Requires-Dist: poyo; extra == "test"
+
+> :warning: WARNING: This is a work in progress. It doesn't have documentation. Do NOT use it.
+
+# Proper
+
+A web framework optimized for programmer happiness.
+
+
+### Requirements
+
+- Python 3.10+
+
+
+### Installation
+
+	pip install proper
+
+
+## Design principles
+
+- "Convention over configuration".
+
+- No globals.
+	When you need a shared object, pass it arround.
+
+- Optimize for the 95%.
+	Don't compromise the usability of the common cases to keep consistency
+	with the edge cases.
+
+- Code redability is important.
+
+- App-code over framework-code
+	Because app code is infintely configurable without dirty hacks.
+
+- "Everyone is an adult here".
+	Run with scissors if you must.
+
+- Regular WSGI is great.
+
+
+# Sources of inspirations
+
+## From Elixir/Phoenix
+
+### App-code over framework-code.
+
+You can make it clean and straightforward or you can make it configurable.
+But if you put the code in the application, thanks to a standarized project skeleton,
+you can have both!
+
+
+## From Ruby/Rails
+
+### Convention over configuration.
+
+### Optimize for developer happiness.
+
+### The application code must be beatiful.
+
+- Empty class-based views that works!
+- Class-based views allows several tricks that make the experience much better:
+	- A configurable and plugganle render and view functions.
+	- Class based views a-la Django, but simpler and completely obvious because is your application code (see (App-code over framework-code)
+	- Saving context varaibles in your view instance looks much cleaner that building a dictionary and manually calling render and the end of each view.
+
+
+![Visualization of the codebase](./diagram.svg)

{proper-0.1.dev3 → proper-0.2}/README.md

@@ -7,7 +7,7 @@ A web framework optimized for programmer happiness.
 
 ### Requirements
 
-- Python 3.6+
+- Python 3.10+
 
 
 ### Installation
@@ -41,11 +41,6 @@ A web framework optimized for programmer happiness.
 
 ## From Elixir/Phoenix
 
-### Pipelines in the routes.
-
-You don't need to have a framework for APIs and other for full-fletched apps, you can just deactivate cookie sessions, flash messages and other things yoi don't need for specific sections of your sites.
-And is super easy to add things too like admin-only sections just by composing multiple pipelines, after all, there are just lists of callables.
-
 ### App-code over framework-code.
 
 You can make it clean and straightforward or you can make it configurable.
@@ -61,8 +56,11 @@ you can have both!
 
 ### The application code must be beatiful.
 
-- Empty class-based controllers that works!
-- Class-based controllers allows several tricks that make the experience much better:
+- Empty class-based views that works!
+- Class-based views allows several tricks that make the experience much better:
 	- A configurable and plugganle render and view functions.
 	- Class based views a-la Django, but simpler and completely obvious because is your application code (see (App-code over framework-code)
-	- Saving context varaibles in your controller instance looks much cleaner that building a dictionary and manually calling render and the end of each controller.
+	- Saving context varaibles in your view instance looks much cleaner that building a dictionary and manually calling render and the end of each view.
+
+
+![Visualization of the codebase](./diagram.svg)

proper-0.2/pyproject.toml

@@ -0,0 +1,222 @@
+[build-system]
+requires = ["setuptools"]
+
+
+[project]
+name = "proper"
+version = "0.2"
+description = "A web framework optimized for programmer happiness"
+authors = [
+  {name = "Juan-Pablo Scaletti", email = "juanpablo@jpscaletti.com"},
+]
+license = { "file" = "MIT-LICENSE" }
+readme = "README.md"
+requires-python = ">=3.10"
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Environment :: Web Environment",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3 :: Only",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Typing :: Typed",
+]
+dependencies = [
+  "inflection >= 0.5.1",
+  "isort >= 5.0",
+  "itsdangerous >= 1.1",
+  "jinjax >= 0.30",
+  "mailshake",
+  "markupsafe >= 2.0",
+  "passlib >= 1.7",
+  "peewee >= 3.15",
+  "peewee-migrate >= 1.12.1, < 2",
+  "proper-cli >= 1.2",
+  "tomlkit >= 0.12.4",
+  "traceback-with-variables == 2.0.4",
+  "uwsgi >= 2.0",
+]
+
+
+[project.optional-dependencies]
+dev = [
+  "ipdb >= 0.13",
+  "pyright >= 1.1",
+  "pre-commit",
+  "ruff >= 0.2.0",
+]
+test = [
+  "pytest >= 7.2",
+  "pytest-cov",
+  "tox",
+  # To test installable frameworks
+  "image-processing-egg",
+  "poyo",
+]
+
+
+[project.urls]
+homepage = "https://proper.scaletti.dev/"
+repository = "https://github.com/jpsca/proper"
+documentation = "https://proper.scaletti.dev/"
+
+
+[project.scripts]
+proper = "proper.cl:run"
+
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+
+[tool.setuptools.package-data]
+proper = [
+  "src/blueprints/*",
+  "src/core/templates/*",
+]
+
+
+[tool.coverage.run]
+branch = true
+
+
+[tool.coverage.report]
+exclude_lines = [
+    "pragma: no cover",
+    "TYPE_CHECKING",
+    "def __repr__",
+    "def __str__",
+    "raise AssertionError",
+    "raise NotImplementedError",
+    "if __name__ == .__main__.:"
+]
+omit = [
+    "src/blueprints/*",
+    "src/proper/app_test.py",
+    "src/proper/cl/*",
+    "src/proper/storage/*", # TODO
+]
+
+
+[tool.coverage.html]
+directory = "covreport"
+
+
+[tool.pyright]
+include = ["src"]
+exclude = [
+    "**/node_modules",
+    "**/__pycache__",
+    "**/tests",
+]
+ignore = ["src/blueprints"]
+reportPrivateImportUsage = false
+reportWildcardImportFromLibrary = false
+
+
+[tool.pytest.ini_options]
+addopts = "--doctest-modules"
+
+
+[tool.tox]
+legacy_tox_ini = """
+[tox]
+skipsdist = True
+envlist = py310,py311,py312
+
+[testenv]
+skip_install = true
+commands =
+    pip install -U uv
+    uv pip install requirements-text.txt
+    pytest -x src/proper tests
+"""
+
+
+[tool.ruff]
+line-length = 90
+indent-width = 4
+target-version = "py311"
+
+exclude = [
+  ".*",
+  "_build",
+  "build",
+  "covreport",
+  "dist",
+  "src/blueprints/*",
+]
+include = ["*.py"]
+
+
+[tool.ruff.format]
+# Like Black, use double quotes for strings.
+quote-style = "double"
+
+# Like Black, indent with spaces, rather than tabs.
+indent-style = "space"
+
+# Like Black, respect magic trailing commas.
+skip-magic-trailing-comma = false
+
+# Like Black, automatically detect the appropriate line ending.
+line-ending = "auto"
+
+# Enable auto-formatting of code examples in docstrings. Markdown,
+# reStructuredText code/literal blocks and doctests are all supported.
+#
+# This is currently disabled by default, but it is planned for this
+# to be opt-out in the future.
+docstring-code-format = false
+
+# Set the line length limit used when formatting code snippets in
+# docstrings.
+#
+# This only has an effect when the `docstring-code-format` setting is
+# enabled.
+docstring-code-line-length = "dynamic"
+
+
+[tool.ruff.lint]
+fixable = ["ALL"]
+
+ignore = [
+	# x is too complex
+	"C901",
+	# whitespace before ':'
+	"E203",
+	"E501",
+	# x defined from star imports
+	"F405",
+	# line break before binary operator
+	"W505",
+	"W605",
+]
+select = [
+	# bugbear
+	"B",
+	# mccabe"", comprehensions, commas
+	"C",
+	# pycodestyle errors
+	"E",
+	# pyflakes
+	"F",
+	# logging format
+	"G",
+	# imports
+	"I",
+	# quotes
+	"Q",
+	# pycodestyle warnings
+	"W",
+]
+
+
+[tool.ruff.lint.isort]
+known-first-party = ["proper"]
+known-local-folder = ["src/proper"]
+
+# Use two line after imports.
+lines-after-imports = 2

proper-0.2/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

proper-0.2/src/blueprints/app/[[ app_name ]]/__init__.py

@@ -0,0 +1,5 @@
+# The order of these imports is important
+from . import app  # noqa
+from . import initializers  # noqa
+from . import routes  # noqa
+from . import models  # noqa

proper-0.2/src/blueprints/app/[[ app_name ]]/app.py

@@ -0,0 +1,8 @@
+from proper import App
+
+
+app = App(__name__)
+config = app.config
+
+if app.catalog:
+    app.catalog.add_folder(app.components_path / "common")

proper-0.2/src/blueprints/app/[[ app_name ]]/cl/__init__.tt.py

@@ -0,0 +1,5 @@
+from [[ app_name ]].app import app
+
+
+class AppCL(app.CL):
+    """Custom commands for this application"""

proper-0.2/src/blueprints/app/[[ app_name ]]/config/app.tt.py

@@ -0,0 +1,52 @@
+from proper import env, DEV, PROD
+
+from .database import *  # noqa
+from .session import *  # noqa
+from .storage import *  # noqa
+
+
+DEBUG: bool = env == DEV
+
+if env == PROD:
+    HOST: str = "https://YOUR-DOMAIN.com"
+else:
+    HOST: str = "http://127.0.0.1:2300"
+
+# List of secret keys, **OLDEST TO NEWEST**.
+# Every key in the list is valid, so you can periodically generate a new key
+# and remove the oldest one to add and extra layer of mitigation
+# against a improbable discovery of the current secret key
+if env == PROD:
+    SECRET_KEYS: list[str] = [
+        "..."
+    ]
+else:
+    SECRET_KEYS: list[str] = [
+        "---- This is a not-secret-secret_key just for development ----"
+    ]
+
+# Turn off to let debugging WSGI middleware handle exceptions.
+CATCH_ALL_ERRORS: bool = True
+
+# Limits the total content length (in bytes).
+# Raises a RequestEntityTooLarge exception if this value is exceeded.
+MAX_CONTENT_LENGTH: int = 2**23  # 8 MB
+
+# Limits the content length (in bytes) of the query string.
+# Raises a RequestEntityTooLarge or an UriTooLong if this value is exceeded.
+MAX_QUERY_SIZE: int = 2**20  # 1 MB
+
+
+COMPONENTS_FOLDER = "components"
+COMPONENTS_URL = "/components"
+
+# The name of the header to use to return a file
+# so the proxy or web-server does it instead of our application.
+# Lighttpd uses "X-Sendfile" while NGINX uses "X-Accel-Redirect"
+if env == PROD:
+    STATIC_X_SENDFILE_HEADER = "X-Accel-Redirect"
+else:
+    STATIC_X_SENDFILE_HEADER = ""
+
+
+MAILER_DEFAULT_FROM = "hello@example.com"

proper-0.2/src/blueprints/app/[[ app_name ]]/config/database.tt.py

@@ -0,0 +1,40 @@
+import os
+
+from proper import DEV, PROD, env
+
+
+DATABASE_ENGINES = {
+    "sqlite": {
+        "type": "playhouse.sqlite_ext.SqliteExtDatabase",
+        "database": "db/sqlite.db",
+    },
+    "postgres": {
+        "type": "playhouse.postgres_ext.PostgresqlExtDatabase",
+        "database": os.getenv("DB_NAME", "[[ app_name ]]"),
+        "host": os.getenv("DB_HOST", "127.0.0.1"),
+        "port": int(os.getenv("DB_PORT", 5432)),
+        "user": os.getenv("DB_USER", "root"),
+        "password": os.getenv("DB_PASSWORD", ""),
+        # The connection is managed in a concern of the view,
+        # and on the `on_teardown` and `on_error` hooks
+        "autoconnect": False,
+    },
+    "maria": {
+        "type": "peewee.MySQLDatabase",
+        "database": os.getenv("DB_NAME", "[[ app_name ]]"),
+        "host": os.getenv("DB_HOST", "127.0.0.1"),
+        "port": int(os.getenv("DB_PORT", 3306)),
+        "user": os.getenv("DB_USER", "root"),
+        "password": os.getenv("DB_PASSWORD", ""),
+        # The connection is managed iin a concern of the view,
+        # and on the `on_teardown` and `on_error` hooks
+        "autoconnect": False
+    },
+}
+
+if env == PROD:
+    DATABASE: str = "postgres"
+elif env == DEV:
+    DATABASE: str = "sqlite"
+else:
+    DATABASE: str = "sqlite"

proper-0.2/src/blueprints/app/[[ app_name ]]/config/session.py

@@ -0,0 +1,13 @@
+from datetime import timedelta
+
+from proper import PROD, env
+
+
+SESSION_LIFETIME: int = int(timedelta(days=30).total_seconds())
+SESSION_COOKIE_NAME: str = "_session"
+SESSION_COOKIE_DOMAIN: str | None = None
+SESSION_COOKIE_PATH: str = "/"
+SESSION_COOKIE_HTTPONLY: bool = True
+SESSION_COOKIE_SECURE: bool = env == PROD
+# "Lax", "Strict", or None
+SESSION_COOKIE_SAMESITE: bool = False

proper-0.2/src/blueprints/app/[[ app_name ]]/config/storage.py

@@ -0,0 +1,8 @@
+import os
+
+
+REDIS_HOST: str = os.getenv("REDIS_HOST", "127.0.0.1")
+REDIS_PORT: int = int(os.getenv("REDIS_PORT", 6379))
+REDIS_USER: str | None = os.getenv("REDIS_USER")
+REDIS_PASSWORD: str | None = os.getenv("REDIS_PASSWORD")
+REDIS_DB: int = int(os.getenv("REDIS_DB", 0))

proper-0.2/src/blueprints/app/[[ app_name ]]/initializers/1_app.tt.py

@@ -0,0 +1,25 @@
+import subprocess
+import sys
+
+from [[ app_name ]].app import app
+from [[ app_name ]].cl import AppCL
+
+
+app.CL = AppCL
+
+
+@app.on_dev_start
+def compile_tailwind():
+    from pytailwindcss import get_bin_path
+
+    cmd = [
+        str(get_bin_path()),
+        "-i",
+        "static_src/css/app.css",
+        "-o",
+        "static/css/app.css",
+        "--watch",
+    ]
+    scmd = " ".join(cmd)
+    print("Running",f'"{scmd}"')
+    subprocess.Popen(cmd, stdout=sys.stdout, stderr=sys.stderr)

proper-0.2/src/blueprints/app/[[ app_name ]]/initializers/2_database.py

@@ -0,0 +1,22 @@
+from importlib import import_module
+
+from ..app import app, config
+
+
+db_config = config.DATABASE_ENGINES[config.DATABASE].copy()
+mod_name, cls_name = db_config.pop("type").rsplit(".", 1)
+mod = import_module(mod_name)
+Cls = getattr(mod, cls_name)
+app.db = Cls(**db_config)
+
+
+@app.on_error
+def on_error():
+    if app.db and not app.db.is_closed():
+        app.db.rollback()
+
+
+@app.on_teardown
+def on_teardown():
+    if app.db and not app.db.is_closed():
+        app.db.close()

proper-0.2/src/blueprints/app/[[ app_name ]]/initializers/__init__.py

@@ -0,0 +1,10 @@
+"""Import all the modules in this folder."""
+from importlib import import_module
+from pathlib import Path
+from pkgutil import iter_modules
+
+
+# iterate through the modules in the current package
+package_dir = str(Path(__file__).resolve().parent)
+for (_, module_name, __) in iter_modules([package_dir]):
+    import_module(f"{__name__}.{module_name}")

proper-0.2/src/blueprints/app/[[ app_name ]]/initializers/error_handlers.py

@@ -0,0 +1,15 @@
+import proper
+
+from ..app import app
+from ..views.page import Page
+
+
+# You can call your own views for handling any kind of exception, not
+# only HTTP exceptions but custom ones or even native Python exceptions
+# like `ValueError` or a catch-all Exception.
+#
+# If `app.config.DEBUG = True`, this also will create test routes
+# (based on the name of the exception class) to preview those pages
+# so you can test their design.
+app.error_handler(proper.errors.NotFound, Page.not_found)  # /_not_found
+app.error_handler(Exception, Page.error)  # /_exception

proper-0.2/src/blueprints/app/[[ app_name ]]/mailers/mailer.py

@@ -0,0 +1,11 @@
+from mailshake import ToConsoleMailer
+
+from ..app import config
+
+
+mailer = ToConsoleMailer()
+
+
+def send_email(to, subject, **kw):
+    kw.setdefault("from_email", config.MAILER_DEFAULT_FROM)
+    mailer.send(to=to, subject=subject, **kw)

proper-0.2/src/blueprints/app/[[ app_name ]]/models/__init__.py

@@ -0,0 +1,5 @@
+"""
+Import here all the models you want to be detected for migrations
+You can also do `from .your_model import *  #noqa` here
+and, in your model file, use `__all__` to define what to import
+"""

proper-0.2/src/blueprints/app/[[ app_name ]]/models/base.py

@@ -0,0 +1,20 @@
+import inflection
+import peewee as pw
+
+from ..app import app
+
+
+def make_table_name(cls):
+    return inflection.tableize(cls.__name__)
+
+
+class BaseModel(pw.Model):
+    class Meta:
+        database = app.db
+        table_function = make_table_name
+
+
+class BaseMixin(pw.Model):
+    class Meta:
+        database = app.db
+        table_function = make_table_name

proper-0.2/src/blueprints/app/[[ app_name ]]/models/concerns/timestamped.tt.py

@@ -0,0 +1,14 @@
+from datetime import datetime
+
+import peewee as pw
+
+from [[ app_name ]].models.base import BaseMixin
+
+
+class Timestamped(BaseMixin):
+    created_at = pw.DateTimeField(default=datetime.utcnow, null=True)
+    updated_at = pw.DateTimeField(default=datetime.utcnow, null=True)
+
+    def update(self, *args, **kwargs):
+        self.updated_at = datetime.utcnow()
+        return super().update(*args, **kwargs)