django-small-view-set 0.1.2__py3-none-any.whl → 0.1.3__py3-none-any.whl

{django_small_view_set-0.1.2.dist-info → django_small_view_set-0.1.3.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: django-small-view-set
-Version: 0.1.2
+Version: 0.1.3
 Summary: A lightweight Django ViewSet alternative with minimal abstraction.
 Home-page: https://github.com/nateonguitar/django-small-view-set
 License: MIT
@@ -21,10 +21,57 @@ Description-Content-Type: text/markdown
 
 A lightweight Django ViewSet alternative with minimal abstraction. This library provides a simple and transparent way to define API endpoints without relying on complex abstractions.
 
+## Getting Started with Django Small View Set
+
+This guide provides a simple example to get started with the library.
+
+### Example Usage
+
+Here’s how you can define a basic API endpoint with one collection route and one detail route:
+
+```python
+from django.http import JsonResponse
+from django.urls import path
+from small_view_set.small_view_set import SmallViewSet
+from small_view_set.decorators import default_handle_endpoint_exceptions
+
+class BarViewSet(SmallViewSet):
+
+    def urlpatterns(self):
+        return [
+            path('api/bars/',          self.default_router, name='bars_collection'),
+            path('api/bars/<int:pk>/', self.default_router, name='bars_detail'),
+        ]
+
+    @default_handle_endpoint_exceptions
+    def list(self, request, *args, **kwargs):
+        self.protect_list(request)
+        return JsonResponse({"message": "Hello, world!"}, status=200)
+
+    @default_handle_endpoint_exceptions
+    def retrieve(self, request, pk, *args, **kwargs):
+        self.protect_retrieve(request)
+        return JsonResponse({"message": f"Detail for ID {pk}"}, status=200)
+```
+
+
+## Registering in `urls.py`
+
+To register the viewset in your `urls.py`:
+
+```python
+from api.views.bar import BarViewSet
+
+urlpatterns = [
+    # Other URLs like admin, static, etc.
+
+    *BarViewSet().urlpatterns(),
+]
+```
+
+
 ## Documentation
 
-- [Getting Started](./README_SIMPLE.md): A bare-bones example to get the fundamentals.
-- [Register URLs](./README_REGISTER_URLS.md): How to register viewset urls.
 - [Custom Endpoints](./README_CUSTOM_ENDPOINT.md): Learn how to define custom endpoints alongside the default router.
 - [Handling Endpoint Exceptions](./README_HANDLE_ENDPOINT_EXCEPTIONS.md): Understand how to write your own decorators for exception handling.
 - [Custom Protections](./README_CUSTOM_PROTECTIONS.md): Learn how to subclass `SmallViewSet` to add custom protections like logged-in checks.

{django_small_view_set-0.1.2.dist-info → django_small_view_set-0.1.3.dist-info}/RECORD

@@ -3,7 +3,7 @@ small_view_set/__init__.py,sha256=FoYcTj03W41-w0jC1EOv1_VD4iBxO_03fIr_plSKnp8,44
 small_view_set/decorators.py,sha256=OSwGz5SfTw7hUjOcPNmCmUl8mLqaHOMXaLcqg9JBHXo,6750
 small_view_set/exceptions.py,sha256=8CAnzvNZFlqjez8z66jLo-4P3Tlj5Y5MioDPmrb9wQg,948
 small_view_set/small_view_set.py,sha256=THDeJp1PmodaWzFUUnowpDmhH8w1El4p97jvQnjyU4k,5192
-django_small_view_set-0.1.2.dist-info/LICENSE,sha256=M4ZuHeiGHHuewaZyqz7tol4E6E2GMz7fF1ywNoXD1tA,1069
-django_small_view_set-0.1.2.dist-info/METADATA,sha256=YYwYTVNT_Dy9QrDg1EjtEUbKcuNYBXhEtkLLO3bV3f0,1722
-django_small_view_set-0.1.2.dist-info/WHEEL,sha256=d2fvjOD7sXsVzChCqf0Ty0JbHKBaLYwDbGQDwQTnJ50,88
-django_small_view_set-0.1.2.dist-info/RECORD,,
+django_small_view_set-0.1.3.dist-info/LICENSE,sha256=M4ZuHeiGHHuewaZyqz7tol4E6E2GMz7fF1ywNoXD1tA,1069
+django_small_view_set-0.1.3.dist-info/METADATA,sha256=CfEGIqD7i2PPsYsDf-k8ksloNXlOGCutgaaqhH_BQd8,2881
+django_small_view_set-0.1.3.dist-info/WHEEL,sha256=d2fvjOD7sXsVzChCqf0Ty0JbHKBaLYwDbGQDwQTnJ50,88
+django_small_view_set-0.1.3.dist-info/RECORD,,