Skip to content

Commit

Permalink
fixed syntax error changed "saccess" to "success"
Browse files Browse the repository at this point in the history
  • Loading branch information
QuvonchbekBobojonov committed Dec 5, 2024
1 parent ddb3609 commit d13b4e9
Show file tree
Hide file tree
Showing 53 changed files with 291 additions and 741 deletions.
2 changes: 1 addition & 1 deletion .idea/misc.xml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion .idea/saccessResponse.iml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

56 changes: 26 additions & 30 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,38 +1,38 @@
# Django Saccess Response
# Django Success Response

`django-saccess-response` is a Django REST Framework extension that provides a standardized success response format for API views. It simplifies handling both successful and error responses with customizable data structures.
`django-success-response` is a Django REST Framework extension that provides a standardized success response format for API views. It simplifies handling both successful and error responses with customizable data structures.

## Installation

Install the package via pip:

```bash
pip install django-saccess-response
pip install django-success-response
```

## Usage

In your Django views, use `SaccessResponse` to wrap the response data.
In your Django views, use `SuccessResponse` to wrap the response data.

### Example: Standard Success Response

```python
from saccess_response.response import SaccessResponse
from success_response.response import SuccessResponse
from rest_framework.views import APIView


class MyView(APIView):
@staticmethod
def get(request):
data = {'key': 'value'}
return SaccessResponse(data)
return SuccessResponse(data)
```

### Result:

```json
{
"saccess": true,
"success": true,
"result": {
"key": "value"
}
Expand All @@ -41,25 +41,25 @@ class MyView(APIView):

### Example: Error Response

To handle errors, pass `saccess=False`:
To handle errors, pass `success=False`:

```python
from saccess_response.response import SaccessResponse
from success_response.response import SuccessResponse
from rest_framework.views import APIView


class MyView(APIView):
@staticmethod
def get(request):
data = {'key': 'value'}
return SaccessResponse(data, saccess=False)
return SuccessResponse(data, success=False)
```

### Result:

```json
{
"saccess": false,
"success": false,
"result": {
"detail": "error"
}
Expand All @@ -72,31 +72,27 @@ You can also customize Django REST Framework's error responses globally by modif

```python
REST_FRAMEWORK = {
'EXCEPTION_HANDLER': 'saccess_response.views.saccess_exception_handler'
'EXCEPTION_HANDLER': 'success_response.views.success_exception_handler'
}
```

This will format all exceptions using the `SaccessResponse` structure.
This will format all exceptions using the `SuccessResponse` structure.

## Generic Views and ViewSets

This package also provides customized DRF generic views and viewsets for standardized response handling.

| Standard View | Saccess Equivalent |
| Standard View | Success Equivalent |
|--------------------------------|---------------------------------------|
| `CreateAPIView` | `SaccessCreateAPIView` |
| `RetrieveAPIView` | `SaccessRetrieveAPIView` |
| `UpdateAPIView` | `SaccessUpdateAPIView` |
| `DestroyAPIView` | `SaccessDestroyAPIView` |
| `ListAPIView` | `SaccessListAPIView` |
| `RetrieveUpdateAPIView` | `SaccessRetrieveUpdateAPIView` |
| `RetrieveDestroyAPIView` | `SaccessRetrieveDestroyAPIView` |
| `RetrieveUpdateDestroyAPIView` | `SaccessRetrieveUpdateDestroyAPIView` |
| `ModelViewSet` | `SaccessModelViewSet` |
| `ReadOnlyModelViewSet` | `SaccessReadOnlyModelViewSet` |

These classes behave like their DRF counterparts but automatically format responses using `SaccessResponse`.

## License

This project is licensed under the MIT License. See the [LICENSE](./LICENSE) file for details.
| `CreateAPIView` | `SuccessCreateAPIView` |
| `RetrieveAPIView` | `SuccessRetrieveAPIView` |
| `UpdateAPIView` | `SuccessUpdateAPIView` |
| `DestroyAPIView` | `SuccessDestroyAPIView` |
| `ListAPIView` | `SuccessListAPIView` |
| `RetrieveUpdateAPIView` | `SuccessRetrieveUpdateAPIView` |
| `RetrieveDestroyAPIView` | `SuccessRetrieveDestroyAPIView` |
| `RetrieveUpdateDestroyAPIView` | `SuccessRetrieveUpdateDestroyAPIView` |
| `ModelViewSet` | `SuccessModelViewSet` |
| `ReadOnlyModelViewSet` | `SuccessReadOnlyModelViewSet` |

These classes behave like their DRF counterparts but automatically format responses using `SuccessResponse`.
12 changes: 0 additions & 12 deletions build/lib/saccess_response/exceptions.py

This file was deleted.

108 changes: 0 additions & 108 deletions build/lib/saccess_response/generics.py

This file was deleted.

53 changes: 0 additions & 53 deletions build/lib/saccess_response/mixins.py

This file was deleted.

This file was deleted.

37 changes: 0 additions & 37 deletions build/lib/saccess_response/views.py

This file was deleted.

Loading

0 comments on commit d13b4e9

Please sign in to comment.