Skip to main content

A Django management command to generate views and serializers based on models.

Project description

Django View and Serializer Generator This Django management command automatically generates views.py and serializers.py files with basic viewsets and serializers for each model defined in the project’s models.py file. It saves development time by creating boilerplate code for API views and serializers based on your models.

Features Automatically generates views.py and serializers.py files based on models defined in a specified Django app. Creates a ModelViewSet for each model in views.py to enable CRUD operations. Generates a ModelSerializer for each model in serializers.py, including all model fields. Installation To install this library, use pip:

bash Copy code pip install django-view-serializer-generator Then, add the app to your Django project's INSTALLED_APPS:

python Copy code

settings.py

INSTALLED_APPS = [ # Other installed apps 'view_serializer_generator', # Add the generator app ] Usage Navigate to your Django project directory where manage.py is located.

Run the command to generate views and serializers:

bash Copy code python manage.py generate_views_and_serializers The command will look for models defined in the app specified in the code and generate views.py and serializers.py with the appropriate viewsets and serializers.

Example Output The command creates views.py and serializers.py in the specified app (e.g., Paypal), with code similar to:

serializers.py

python Copy code from rest_framework import serializers from .models import YourModel

class YourModelSerializer(serializers.ModelSerializer): class Meta: model = YourModel fields = 'all' views.py

python Copy code from rest_framework import viewsets from .models import YourModel from .serializers import YourModelSerializer

class YourModelViewSet(viewsets.ModelViewSet): queryset = YourModel.objects.all() serializer_class = YourModelSerializer Folder Structure To follow best practices, maintain the following folder structure:

markdown Copy code myproject/ ├── myapp/ │ ├── management/ │ │ └── commands/ │ │ └── generate_views_and_serializers.py │ ├── migrations/ │ ├── init.py │ ├── models.py │ ├── serializers.py │ ├── views.py │ ├── urls.py ├── manage.py ├── settings.py Customizing the Command By default, this command looks for an app named Paypal. If your app has a different name, update the app_name variable in generate_views_and_serializers.py:

python Copy code app_name = 'YourAppName' License This project is licensed under the MIT License - see the LICENSE file for details.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

my_django_generator-0.1.0.tar.gz (4.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

my_django_generator-0.1.0-py3-none-any.whl (5.5 kB view details)

Uploaded Python 3

File details

Details for the file my_django_generator-0.1.0.tar.gz.

File metadata

  • Download URL: my_django_generator-0.1.0.tar.gz
  • Upload date:
  • Size: 4.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.6

File hashes

Hashes for my_django_generator-0.1.0.tar.gz
Algorithm Hash digest
SHA256 c275cda94fbf563cc8d3a1ddbdbf8411a042f648cf73db2cfbb05a34702e89c8
MD5 6b9be64facf7939f157b107196ac088b
BLAKE2b-256 837f6e9649607780a87e5002eb0f0c35cfff82a210a1f99ed4012aa30dff5f10

See more details on using hashes here.

File details

Details for the file my_django_generator-0.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for my_django_generator-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 2ac9c6e9b8b937def203d12db007ca59adec05e4197f1e0365d4b4d3a03d3b6a
MD5 749c0d8ffc01b920de906199eb8551f0
BLAKE2b-256 862376afd450bfc905f19cca89153b28a423dcab9a4ff282c3c53597d10a8b89

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page