Skip to main content

No project description provided

Project description

Build Status pypi python license Development status https://coveralls.io/repos/github/hulygun/django-api-toolkit/badge.svg?branch=master

Instalation

pip install django-api-toolkit

Get started

In the first you need initialize your project

project_init <path to project>

For existing projects you should to generate env file

env_generator <path to project>

This script generate base variables that needed to run project. You can also add youself variables in env file You should also change your manage.py. Add APIManager to your file. e.q.

#!/usr/bin/env python
import sys

from api_tools.utils import APIManager

if __name__ == "__main__":
    er = APIManager(__file__, 'cfg.settings')  # path to user project settings
    er.set_app_dir('apps')  # directory for user project applications
    er.apply()  # apply settings

    from django.core.management import execute_from_command_line
    execute_from_command_line(sys.argv)

Usage

Structure

├── apps  # dir for your apps
├── cfg  # dir for diferent project configurations
   ├── settings.py # user project settings
   └── wsgi.py
└── manage.py

Settings

  • COMMON_APPS - django common applications

  • THIRD_PARTY_APPS - third party applications

  • EXTRA_APPS - applications should be insted before common apps

  • PROJECT_APPS - your project applications

You also can overwrite other standard django settings keys and add yourself variables

Models

All project models should be inherited of RestModel(this standart django abstract model and you can use all capabilities of this)

from api_tools.models import RestModel

class MyModel(RestModel):
    ...

Advanced

RestModel have subclass Rest. This subclass have properties for control your rest models. RestModel also have classmethods for these controls.

RestModel overwrites

RestModel.Rest

queryset:

defines queryset as lambda of model.objects

fields:

list of allowed fields of model

name:

name of viewset

route:

route of endpoint

RestModel._rest_serializer

Defines serializer for viewset of model

RestModel._rest_queryset

Defines queryset for viewset

RestModel._rest_endpoint

Set endpoint for your model

FEATURES

CHANGELOG

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

django-api-toolkit-0.1.6.tar.gz (7.8 kB view details)

Uploaded Source

File details

Details for the file django-api-toolkit-0.1.6.tar.gz.

File metadata

File hashes

Hashes for django-api-toolkit-0.1.6.tar.gz
Algorithm Hash digest
SHA256 e62411f01578ad193838a2930bd5fa59a442355016c15e7da69eb68cf1d1248c
MD5 7e5f6b7d777abea3f4efe4549d2cb9e5
BLAKE2b-256 3ae260bc0d1e304a4ab94748a8432e982291c29f29dfd1907fe64a211ec53624

See more details on using hashes here.

Supported by

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