Installing

Install and update using pip:

$ pip install -U drf_compose

Usage

Using DRF Compose is basically a two-step process:

• Define your application in a drf-compose.json file.

• Run drf-compose and the DRF compose command generates a ready to use DRF project code.

Command options overview and help

You can also see this information by running drf-compose –help from the command line.

Usage: drf-compose [OPTIONS]

  This script composes a DRF project.

Options:
  -s, --source FILE  Specify an alternate compose file as source  [default: drf-compose.json]
  --yaml             Indicates that the supplied source file is a YAML file
  --help             Show this message and exit.

Options

1. name (required): specifies the project name.

2. app_with_model (required): specifies details describing each apps in the DRF project.

   • app_name (required): specifies the app name

   • models: a list of models belonging to the app

     • name (required): specifies the model name

     • meta: specifies the different model meta options as in the Django model meta documentation

     • fields (required): a list of fields belonging to a model.

       • name (required): the name of the field as in the Django model field documentation

       • type (required): the field type as specified in Django model field type reference documentation. Basic syntax sugar also supported as shown below:

         Syntax	Field Type
         char	CharField
         text	TextField
         url	URLField
         datetime	DatetimeField
         fk	ForeignKey
         o2o	OneToOneField
         m2m	ManyToManyField

       • options: specifies field option as in the Django model field documentation.

     • use_uuid_as_key (boolean): if True, a UUID is used as the model’s primary key.

     • str: specifies the field to be returned as representation of the model in __str__. Must be one of the specified field names

3. auth_app: specifies details of the authentication application.

   • app_name (required): specifies the app name

   • model_name (required): specifies the model name for the custom user model

   • username_field: A string describing the name of the field on the user model that is used as the unique identifier Django USERNAME_FIELD documentation.

   • email_field: A string describing the name of the email field on the User model. Django’s EMAIL_FIELD documentation

   • required_fields: A list of the field names that will be prompted for when creating a user via the createsuperuser management command Django’s REQUIRED_FIELDS documentation

   • meta: specifies the different model meta options as in the Django model meta documentation

   • fields: a list of fields belonging to a model.

     • name (required): the name of the field as in the Django model field documentation

     • type (required): the field type as specified in Django model field type reference documentation. Basic syntax sugar also supported as shown below:

       Syntax	Field Type
       char	CharField
       text	TextField
       url	URLField
       datetime	DatetimeField
       fk	ForeignKey
       o2o	OneToOneField
       m2m	ManyToManyField

     • options: specifies field option as in the Django model field documentation.

   • use_uuid_as_key (boolean): if True, a UUID is used as the model’s primary key.

   • str: specifies the field to be returned as representation of the model in __str__. Must be one of the specified field names

4. include: specifies the addons to be included in the application.

   • simple_jwt (boolean): if True, includes Simple JWT JSON Web Token authentication plugin into the application.

     COMING SOON!

   • django_filter (boolean) if True, includes Django-filter, a reusable Django application allowing users to declaratively add dynamic QuerySet filtering from URL parameters.

   • docker (boolean): if True, includes docker setup option into the application.

   • dj-database-url (boolean): if True, includes DJ-Database-URL , a simple Django utility allows you to utilize the 12factor inspired DATABASE_URL environment variable to configure your Django application.

Links

• Documentation: https://drf-compose.readthedocs.io

• Changes: https://drf-compose.readthedocs.io/changes/

• PyPI Releases: https://pypi.org/project/drf-compose/

• Source Code: https://github.com/IamAbbey/drf_compose

• Issue Tracker: https://github.com/IamAbbey/drf_compose/issues

Credits

This package was created with Cookiecutter and the audreyr/cookiecutter-pypackage project template.