Plinx 0.0.1__py3-none-any.whl → 1.0.1__py3-none-any.whl

plinx/status_codes.py

@@ -2,18 +2,39 @@ from enum import Enum
 
 
 class StatusCodes(Enum):
-    """Status codes for the API."""
+    """
+    Enumeration of HTTP status codes supported by the Plinx framework.
 
-    # 2XX
+    This enum defines standard HTTP status codes as defined in RFC 7231,
+    organized by their categories (2xx for success, 3xx for redirection, etc.).
+
+    Each status code has a name that reflects its standard description,
+    and a numeric value that is sent in HTTP responses.
+
+    Usage:
+        ```python
+        from plinx.status_codes import StatusCodes
+
+        # Set a 404 status code
+        response.status_code = StatusCodes.NOT_FOUND.value  # 404
+
+        # Get the name of a status code for display
+        status_name = StatusCodes.NOT_FOUND.name  # "NOT_FOUND"
+        # Can be formatted for human display:
+        human_readable = StatusCodes.NOT_FOUND.name.replace("_", " ").title()  # "Not Found"
+        ```
+    """
+
+    # 2XX - Success
     OK = 200
     CREATED = 201
     ACCEPTED = 202
     NO_CONTENT = 204
 
-    # 3XX
+    # 3XX - Redirection
     NOT_MODIFIED = 304
 
-    # 4XX
+    # 4XX - Client Error
     BAD_REQUEST = 400
     UNAUTHORIZED = 401
     FORBIDDEN = 403
@@ -27,7 +48,7 @@ class StatusCodes(Enum):
     TOO_MANY_REQUESTS = 429
     UNAVAILABLE_FOR_LEGAL_REASONS = 451
 
-    # 5XX
+    # 5XX - Server Error
     INTERNAL_SERVER_ERROR = 500
     NOT_IMPLEMENTED = 501
     BAD_GATEWAY = 502

plinx/utils.py

@@ -5,9 +5,24 @@ from plinx.status_codes import StatusCodes
 
 def handle_404(response: Response) -> None:
     """
-    Set the response status code to 404 and return None.
-    :param response:
-    :return:
+    Set up a standardized 404 Not Found response.
+
+    This utility function is used internally by the framework when no route
+    matches the requested URL path. It sets the status code to 404 and
+    the response text to "Not Found".
+
+    Args:
+        response: The Response object to configure with 404 status
+
+    Returns:
+        None
+
+    Example:
+        ```python
+        response = Response()
+        handle_404(response)
+        # response now has status_code=404 and text="Not Found"
+        ```
     """
     response.status_code = StatusCodes.NOT_FOUND.value
     response.text = StatusCodes.NOT_FOUND.name.replace("_", " ").title()

{Plinx-0.0.1.dist-info → plinx-1.0.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: Plinx
-Version: 0.0.1
+Version: 1.0.1
 Summary: Plinx is an experimental, minimalistic, and extensible web framework and ORM written in Python.
 Home-page: https://github.com/dhavalsavalia/plinx
 Author: Dhaval Savalia
@@ -15,12 +15,27 @@ Classifier: Programming Language :: Python :: Implementation :: PyPy
 Requires-Python: >=3.11.0
 Description-Content-Type: text/markdown
 License-File: LICENSE
+Requires-Dist: webob
+Requires-Dist: parse
+Requires-Dist: requests
+Requires-Dist: requests-wsgi-adapter
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: license
+Dynamic: license-file
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
 
 
 # Plinx
 
 ![purpose](https://img.shields.io/badge/purpose-learning-green.svg)
-![PyPI](https://img.shields.io/pypi/v/bumbo.svg)
+![PyPI](https://img.shields.io/pypi/v/Plinx.svg)
 
 **Plinx** is an experimental, minimalistic, and extensible WSGI-based web framework and ORM written in Python.  
 It is designed to be simple, fast, and easy to extend, making it ideal for rapid prototyping and educational purposes.
@@ -29,8 +44,9 @@ It is designed to be simple, fast, and easy to extend, making it ideal for rapid
 
 ## Features
 
-- 🚀 Minimal and fast web framework
-- 🛣️ Intuitive routing system
+- 🚀 Minimal and fast WSGI web framework
+- 💾 Integrated Object-Relational Mapper (ORM)
+- 🛣️ Intuitive routing system (including parameterized and class-based routes)
 - 🧩 Extensible middleware support
 - 🧪 Simple, readable codebase for learning and hacking
 - 📝 Type hints and modern Python best practices
@@ -39,6 +55,12 @@ It is designed to be simple, fast, and easy to extend, making it ideal for rapid
 
 ## Installation
 
+Install from PyPI:
+
+```bash
+pip install Plinx
+```
+
 Install directly from the git source:
 
 ```bash
@@ -52,19 +74,30 @@ pip install git+https://github.com/dhavalsavalia/plinx.git
 Create a simple web application in seconds:
 
 ```python
+# myapp.py
 from plinx import Plinx
 
 app = Plinx()
 
 @app.route("/")
 def index(request, response):
-    response.text = "Hello, world!"
+    response.text = "Hello, Plinx 1.0.1!"
+
+# Example using the ORM (requires database setup)
+# from plinx.orm import Database, Table, Column
+# db = Database("my_database.db")
+# class Item(Table):
+#     name = Column(str)
+#     count = Column(int)
+# db.create(Item)
+# db.save(Item(name="Example", count=1))
 ```
 
-Run your app (example, assuming you have an ASGI server like `uvicorn`):
+Run your app using a WSGI server (like `gunicorn`):
 
 ```bash
-uvicorn myapp:app
+pip install gunicorn
+gunicorn myapp:app
 ```
 
 ## Testing
@@ -77,19 +110,6 @@ pytest --cov=.
 
 ---
 
-## Roadmap
-
-- [x] Web Framework
-  - [x] Routing
-  - [x] Explicit Routing Methods (GET, POST, etc.)
-  - [x] Parameterized Routes
-  - [x] Class Based Routes
-  - [x] Django-like Routes
-  - [x] Middleware Support
-- [ ] ORM
-
----
-
 ## Contributing
 
 Contributions are welcome! Please open issues or submit pull requests for improvements, bug fixes, or new features.
@@ -104,7 +124,7 @@ This project is licensed under the MIT License. See [LICENSE](LICENSE) for detai
 
 ## Author & Contact
 
-Created and maintained by [Dhaval Savalia](https://github.com/dhavalsavalia).  
+Created and maintained by [Dhaval Savalia](https://github.com/dhavalsavalia).
 For questions or opportunities, feel free to reach out via [LinkedIn](https://www.linkedin.com/in/dhavalsavalia/) or open an issue.
 
 ---

plinx-1.0.1.dist-info/RECORD

@@ -0,0 +1,15 @@
+plinx/__init__.py,sha256=TkcBtaKtAwXDE6XKgnkfC-fIzNxtCErHDt0WCh1ZF74,54
+plinx/applications.py,sha256=XM5jPYgeJapYxaGcTzphcpr_281et0QDwPMfAGIbRtA,11483
+plinx/methods.py,sha256=uLZmj3KQ4QF-JVNgq3fVY7kOJkKJDMQghyiogU8m2Yc,2101
+plinx/middleware.py,sha256=Kdeau4eZ5f4nKTlH_CNvaIndYwkgIdtWBP50-khEK5s,5050
+plinx/response.py,sha256=-CgkW4cH9pLSa73YdrnceCInObwPzpSplhnWfAg-360,4079
+plinx/status_codes.py,sha256=dPkHkcnULbhrxk6WYhR5wmrd2sKhOQf409G_OtX8Cug,1536
+plinx/utils.py,sha256=da0uiLEvLMrjROeUJ5lfBTRAIqKoSdKkqImPs1qHsF4,769
+plinx/orm/__init__.py,sha256=ryDdzvF6Eh6RIHyEgym6UKCaFMnMitwucazpiWuvICQ,61
+plinx/orm/orm.py,sha256=-eHAgURYWw5kL9zMCO1Mha5gRcPCbqoAY6BALj-gqJc,15790
+plinx/orm/utils.py,sha256=fkP89dYMcNFUOcRryxGTNUEV0Dr40-qwG-IH2AxY4DQ,118
+plinx-1.0.1.dist-info/licenses/LICENSE,sha256=MljMjTJD6oOY41eZWLDZ4x8FrTUcl7ElKxWIXJXUwLM,1066
+plinx-1.0.1.dist-info/METADATA,sha256=nvJIwZYncIm-dAB8_oZC8FX4W8Ow2yr3UA_xBd1WPEg,3116
+plinx-1.0.1.dist-info/WHEEL,sha256=pxyMxgL8-pra_rKaQ4drOZAegBVuX-G_4nRHjjgWbmo,91
+plinx-1.0.1.dist-info/top_level.txt,sha256=U_4P3aFsTEhhvfiE3sVbJKAG9Fp4IPC5d6zpttayAZw,6
+plinx-1.0.1.dist-info/RECORD,,

{Plinx-0.0.1.dist-info → plinx-1.0.1.dist-info}/WHEEL

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

Plinx-0.0.1.dist-info/RECORD

@@ -1,12 +0,0 @@
-plinx/__init__.py,sha256=oMho3a3JJZllxtj4lLwS96pwWRBvctDJRFww5lfqlBs,32
-plinx/applications.py,sha256=Oy2pO1zyfKWyYXeJ8AuzdoAab6XJThNHDbOdpKWA5-8,5957
-plinx/methods.py,sha256=CEaousqNXbgdyaEL0BdOtAWh1p03jAaAFzXJkY9xII0,294
-plinx/middleware.py,sha256=OiNDhKWpmpKkAIbSWxRzP_tQXSyfDToos-MQMDPSUWM,2161
-plinx/response.py,sha256=oDZPF9V76HhqdUZLzSmoLw_q-GG9hc5krfCBgNm3OfU,1460
-plinx/status_codes.py,sha256=V7vX7_ujYIaVjO3I3eVUnuNKiTXMSov56wJt8tvMbAM,700
-plinx/utils.py,sha256=WaU_j7YXsdlZh3M33B2vXjRPAU26lBeQ5sV2ZasXVwE,352
-Plinx-0.0.1.dist-info/LICENSE,sha256=MljMjTJD6oOY41eZWLDZ4x8FrTUcl7ElKxWIXJXUwLM,1066
-Plinx-0.0.1.dist-info/METADATA,sha256=N-vDBHtG4pV2LKumS4yh40_IYzKKh8PgRf1G3Umw_Q0,2568
-Plinx-0.0.1.dist-info/WHEEL,sha256=tZoeGjtWxWRfdplE7E3d45VPlLNQnvbKiYnx7gwAy8A,92
-Plinx-0.0.1.dist-info/top_level.txt,sha256=U_4P3aFsTEhhvfiE3sVbJKAG9Fp4IPC5d6zpttayAZw,6
-Plinx-0.0.1.dist-info/RECORD,,