feat: django easy api framework base version

Author: freemindcore

.dcignore

@@ -388,3 +388,4 @@ easy/media/
 /.idea/misc.xml
 /.idea/modules.xml
 /.idea/vcs.xml
+/.idea/django-api-framework.iml

.gitignore

@@ -0,0 +1,3 @@
+[settings]
+profile = black
+combine_as_imports = true

.isort.cfg

@@ -0,0 +1,40 @@
+repos:
+- repo: https://github.com/pre-commit/pre-commit-hooks
+  rev:  v4.3.0
+  hooks:
+  - id: check-merge-conflict
+
+- repo: https://github.com/asottile/yesqa
+  rev: v1.3.0
+  hooks:
+  - id: yesqa
+
+-   repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.3.0
+    hooks:
+    -   id: check-yaml
+    -   id: end-of-file-fixer
+        exclude: '.bumpversion.cfg'
+    -   id: trailing-whitespace
+        exclude: '.bumpversion.cfg'
+    -   id: requirements-txt-fixer
+    -   id: detect-private-key
+    -   id: detect-aws-credentials
+        args: [--allow-missing-credentials]
+
+-   repo: https://github.com/psf/black
+    rev: 22.8.0
+    hooks:
+    -   id: black
+
+- repo: https://github.com/PyCQA/isort
+  rev: 5.10.1
+  hooks:
+    - id: isort
+
+- repo: https://github.com/PyCQA/flake8
+  rev: 5.0.4
+  hooks:
+    - id: flake8
+      args: ["--config=setup.cfg"]
+      additional_dependencies: [flake8-isort]

.pre-commit-config.yaml

@@ -0,0 +1,14 @@
+[MASTER]
+load-plugins=pylint_django, pylint_celery
+
+[FORMAT]
+max-line-length=88
+
+[MESSAGES CONTROL]
+disable=missing-docstring,invalid-name
+
+[DESIGN]
+max-parents=13
+
+[TYPECHECK]
+generated-members=REQUEST,acl_users,aq_parent,"[a-zA-Z]+_set{1,2}",save,delete

.pylintrc

@@ -0,0 +1 @@
+freemindcore

CONTRIBUTORS.txt

@@ -0,0 +1,52 @@
+.PHONY: help docs
+.DEFAULT_GOAL := help
+
+help:
+	@fgrep -h "##" $(MAKEFILE_LIST) | fgrep -v fgrep | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}'
+
+clean: ## Removing cached python compiled files
+	find . -name \*pyc  | xargs  rm -fv
+	find . -name \*pyo | xargs  rm -fv
+	find . -name \*~  | xargs  rm -fv
+	find . -name __pycache__  | xargs  rm -rfv
+
+install: ## Install dependencies
+	make clean
+	flit install --deps develop --symlink
+
+lint: ## Run code linters
+	autoflake --remove-all-unused-imports --remove-unused-variables  --ignore-init-module-imports -r easy
+	black --check easy
+	isort --check easy
+	flake8
+	mypy easy
+
+fmt format: ## Run code formatters
+	autoflake --in-place --remove-all-unused-imports --remove-unused-variables --ignore-init-module-imports  -r easy
+	isort easy
+	black easy
+
+test: ## Run tests
+	pytest
+
+test-cov: ## Run tests with coverage
+	pytest --cov=easy --cov-report term
+
+test-cov-full: ## Run tests with coverage term-missing
+	pytest --cov=easy --cov-report term-missing tests
+
+doc-deploy: ## Run Deploy Documentation
+	make clean
+	mkdocs gh-deploy --force
+
+bump:
+	bumpversion patch
+
+bump-feat:
+	bumpversion feat
+
+bump-major:
+	bumpversion major
+
+bump-build:
+	bumpversion build

Makefile

@@ -1,8 +1,58 @@
-# Django Easy API
+# Django Easy API Framework
+
+###  Easy and Fast Django REST framework based on Django-ninja-extra
+
+- Auto CRUD Async API generation for all django models, configurable
+- Domain/Service/Controller base structure for better code organization
+- Base Permission class and more to come
+- Pure class based Django-ninja APIs, based on Django-Ninja-extra
+
+_Note: this project is still in early stage, comments and advices are highly appreciated._
+
+```
+Django-Ninja features :
+
+  Easy: Designed to be easy to use and intuitive.
+  FAST execution: Very high performance thanks to Pydantic and async support.
+  Fast to code: Type hints and automatic docs lets you focus only on business logic.
+  Standards-based: Based on the open standards for APIs: OpenAPI (previously known as Swagger) and JSON Schema.
+  Django friendly: (obviously) has good integration with the Django core and ORM.
+
+Plus Extra:
+  Class Based: Design your APIs in a class based fashion.
+  Permissions: Protect endpoint(s) at ease with defined permissions and authorizations at route level or controller level.
+  Dependency Injection: Controller classes supports dependency injection with python Injector or django_injector. Giving you the ability to inject API dependable services to APIController class and utilizing them where needed
+```
 
 ### Requirements
 - Python >= 3.6
 - Django >= 2.1 
 - pydantic >= 1.6 
 - Django-Ninja-extra >= 0.15.0
 
+### Install
+`pip install django-api-framework`
+
+Then add "easy" to your django INSTALLED_APPS:
+
+```
+[
+    ...,
+    "easy",
+    ...,
+]
+```
+
+
+Get your admin api up and running:
+```
+api_admin_v1 = EasyAPI(
+    urls_namespace="admin_api",
+    version="v1.0.0",
+)
+
+# Automatic Admin API generation
+api_admin_v1.auto_create_admin_controllers()
+```
+
+Please check tests/demo_app for more.

README.md

@@ -0,0 +1,29 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = .
+BUILDDIR      = ./_build
+APP = /app
+
+.PHONY: help livehtml apidocs Makefile
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) -c .
+
+# Build, watch and serve docs with live reload
+livehtml:
+	sphinx-autobuild -b html --host 0.0.0.0 --port 9000 --watch $(APP) -c . $(SOURCEDIR) $(BUILDDIR)/html
+
+# Outputs rst files from django application code
+apidocs:
+	sphinx-apidoc -o $(SOURCEDIR)/api $(APP)
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) -c .

docs/Makefile

@@ -0,0 +1 @@
+# Included so that Django's startproject comment runs against the docs directory