First Commit

Makefile

@@ -0,0 +1,14 @@
+ARG := $(wordlist 2, $(words $(MAKECMDGOALS)), $(MAKECMDGOALS))
+$(eval $(ARG):;@true)
+
+up:
+	python manage.py runserver
+
+startapp:
+	bash scripts/start-app.sh $(ARG)
+
+setup_commom:
+	bash scripts/setup-commom.sh
+
+setup_venv:
+	bash scripts/setup-venv.sh

README.md

@@ -0,0 +1,49 @@
+# DjangoTemplate 
+
+A simple Django Template, with organized architecture, that comes with support for REST API,
+with the Django Rest Framework.
+
+This project aims to serve as a starting point for other projects.
+
+## Table Of Contents
+
+- [Install](#Install)
+- [Usage](#Usage)
+- [Links](#Links)
+
+## Install
+
+You can clone this repository and setup a virtual enviroment with:
+
+'''sh
+make setup_venv
+'''
+
+Or you can intall the requiremnts in a commom way, running:
+
+'''sh
+make setup_commom
+'''
+
+## Usage
+
+This is a simple template for a Django app, with an organized architecture.
+
+The apps, will be installed in the apps folder, with the command:
+
+'''sh
+make startapp appname
+'''
+
+To run the app:
+
+'''sh
+make up
+'''
+
+## Links
+
+Useful links for the usage of the project.
+
+- [Django](https://docs.djangoproject.com/en/3.2/topics/auth/customizing/)
+- [Django Rest Framework](https://www.django-rest-framework.org/)

conf/app_template/admin.py-tpl

@@ -0,0 +1,4 @@
+from django.contrib import admin  # noqa
+from django.utils.translation import gettext_lazy as _  # noqa
+
+# Register your models here.

conf/app_template/config.py-tpl

@@ -0,0 +1,7 @@
+from django.apps import AppConfig
+from django.utils.translation import gettext_lazy as _
+
+
+class {{ camel_case_app_name }}Config(AppConfig):
+    name = 'apps.{{ app_name }}'
+    verbose_name = _("{{ camel_case_app_name }}s")

conf/app_template/models.py-tpl

@@ -0,0 +1,4 @@
+from django.db import models  # noqa
+from django.utils.translation import gettext_lazy as _  # noqa
+
+# Create your models here.

conf/app_template/serializers.py-tpl

@@ -0,0 +1,5 @@
+from rest_framework import serializers  # noqa
+
+from django.utils.translation import gettext_lazy as _  # noqa
+
+# Create your serializers here.

conf/app_template/tests/test_models.py-tpl

@@ -0,0 +1,3 @@
+import pytest  # noqa
+
+# Create your tests here.

conf/app_template/tests/test_serializers.py-tpl

@@ -0,0 +1,3 @@
+import pytest  # noqa
+
+# Create your tests here.

conf/app_template/tests/test_views.py-tpl

@@ -0,0 +1,3 @@
+import pytest  # noqa
+
+# Create your tests here.

conf/app_template/urls.py-tpl

@@ -0,0 +1,13 @@
+from django.urls import include, path
+
+from rest_framework.routers import DefaultRouter
+
+from . import views  # noqa
+
+# Create a router and register our viewsets with it.
+router = DefaultRouter()
+
+# The API URLs are now determined automatically by the router.
+urlpatterns = [
+    path('', include(router.urls)),
+]

conf/app_template/views.py-tpl

@@ -0,0 +1,3 @@
+from django.utils.translation import gettext_lazy as _  # noqa
+
+# Create your views here.

conf/asgi.py

@@ -0,0 +1,16 @@
+"""
+ASGI config for GeoData project.
+
+It exposes the ASGI callable as a module-level variable named ``application``.
+
+For more information on this file, see
+https://docs.djangoproject.com/en/3.2/howto/deployment/asgi/
+"""
+
+import os
+
+from django.core.asgi import get_asgi_application
+
+os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'conf.settings.commom')
+
+application = get_asgi_application()

conf/settings/commom.py

@@ -0,0 +1,135 @@
+"""
+Django settings for GeoData project.
+
+Generated by 'django-admin startproject' using Django 3.2.
+
+For more information on this file, see
+https://docs.djangoproject.com/en/3.2/topics/settings/
+
+For the full list of settings and their values, see
+https://docs.djangoproject.com/en/3.2/ref/settings/
+"""
+
+from pathlib import Path
+
+# Build paths inside the project like this: BASE_DIR / 'subdir'.
+BASE_DIR = Path(__file__).resolve().parent.parent
+
+
+# Quick-start development settings - unsuitable for production
+# See https://docs.djangoproject.com/en/3.2/howto/deployment/checklist/
+
+# SECURITY WARNING: keep the secret key used in production secret!
+SECRET_KEY = 'CHANGE_ME'
+
+# SECURITY WARNING: don't run with debug turned on in production!
+DEBUG = True
+
+ALLOWED_HOSTS = []
+
+
+# Application definition
+
+DJANGO_APPS = [
+    'django.contrib.admin',
+    'django.contrib.auth',
+    'django.contrib.contenttypes',
+    'django.contrib.sessions',
+    'django.contrib.messages',
+    'django.contrib.staticfiles',
+]
+
+THIRD_PARTY_APPS = [
+    'rest_framework',
+]
+
+LOCAL_APPS = [
+
+]
+
+INSTALLED_APPS = DJANGO_APPS + THIRD_PARTY_APPS + LOCAL_APPS
+
+MIDDLEWARE = [
+    'django.middleware.security.SecurityMiddleware',
+    'django.contrib.sessions.middleware.SessionMiddleware',
+    'django.middleware.common.CommonMiddleware',
+    'django.middleware.csrf.CsrfViewMiddleware',
+    'django.contrib.auth.middleware.AuthenticationMiddleware',
+    'django.contrib.messages.middleware.MessageMiddleware',
+    'django.middleware.clickjacking.XFrameOptionsMiddleware',
+]
+
+ROOT_URLCONF = 'conf.urls'
+
+TEMPLATES = [
+    {
+        'BACKEND': 'django.template.backends.django.DjangoTemplates',
+        'DIRS': [],
+        'APP_DIRS': True,
+        'OPTIONS': {
+            'context_processors': [
+                'django.template.context_processors.debug',
+                'django.template.context_processors.request',
+                'django.contrib.auth.context_processors.auth',
+                'django.contrib.messages.context_processors.messages',
+            ],
+        },
+    },
+]
+
+WSGI_APPLICATION = 'conf.wsgi.application'
+
+
+# Database
+# https://docs.djangoproject.com/en/3.2/ref/settings/#databases
+
+DATABASES = {
+    'default': {
+        'ENGINE': 'django.db.backends.sqlite3',
+        'NAME': BASE_DIR / 'db.sqlite3',
+    }
+}
+
+
+# Password validation
+# https://docs.djangoproject.com/en/3.2/ref/settings/#auth-password-validators
+
+AUTH_PASSWORD_VALIDATORS = [
+    {
+        'NAME': 'django.contrib.auth.password_validation.UserAttributeSimilarityValidator',
+    },
+    {
+        'NAME': 'django.contrib.auth.password_validation.MinimumLengthValidator',
+    },
+    {
+        'NAME': 'django.contrib.auth.password_validation.CommonPasswordValidator',
+    },
+    {
+        'NAME': 'django.contrib.auth.password_validation.NumericPasswordValidator',
+    },
+]
+
+
+# Internationalization
+# https://docs.djangoproject.com/en/3.2/topics/i18n/
+
+LANGUAGE_CODE = 'en-us'
+
+TIME_ZONE = 'UTC'
+
+USE_I18N = True
+
+USE_L10N = True
+
+USE_TZ = True
+
+
+# Static files (CSS, JavaScript, Images)
+# https://docs.djangoproject.com/en/3.2/howto/static-files/
+
+STATIC_URL = '/static/'
+
+# Default primary key field type
+# https://docs.djangoproject.com/en/3.2/ref/settings/#default-auto-field
+
+DEFAULT_AUTO_FIELD = 'django.db.models.BigAutoField'

conf/urls.py

@@ -0,0 +1,21 @@
+"""GeoData URL Configuration
+
+The `urlpatterns` list routes URLs to views. For more information please see:
+    https://docs.djangoproject.com/en/3.2/topics/http/urls/
+Examples:
+Function views
+    1. Add an import:  from my_app import views
+    2. Add a URL to urlpatterns:  path('', views.home, name='home')
+Class-based views
+    1. Add an import:  from other_app.views import Home
+    2. Add a URL to urlpatterns:  path('', Home.as_view(), name='home')
+Including another URLconf
+    1. Import the include() function: from django.urls import include, path
+    2. Add a URL to urlpatterns:  path('blog/', include('blog.urls'))
+"""
+from django.contrib import admin
+from django.urls import path
+
+urlpatterns = [
+    path('admin/', admin.site.urls),
+]

conf/wsgi.py

@@ -0,0 +1,16 @@
+"""
+WSGI config for GeoData project.
+
+It exposes the WSGI callable as a module-level variable named ``application``.
+
+For more information on this file, see
+https://docs.djangoproject.com/en/3.2/howto/deployment/wsgi/
+"""
+
+import os
+
+from django.core.wsgi import get_wsgi_application
+
+os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'conf.settings.commom')
+
+application = get_wsgi_application()

manage.py

@@ -0,0 +1,22 @@
+#!/usr/bin/env python
+"""Django's command-line utility for administrative tasks."""
+import os
+import sys
+
+
+def main():
+    """Run administrative tasks."""
+    os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'conf.settings.commom')
+    try:
+        from django.core.management import execute_from_command_line
+    except ImportError as exc:
+        raise ImportError(
+            "Couldn't import Django. Are you sure it's installed and "
+            "available on your PYTHONPATH environment variable? Did you "
+            "forget to activate a virtual environment?"
+        ) from exc
+    execute_from_command_line(sys.argv)
+
+
+if __name__ == '__main__':
+    main()

requirements/requirements.txt

@@ -0,0 +1,8 @@
+Django==3.2
+
+djangorestframework==3.12.4
+
+pytest-django==4.4.0
+pytest-cov==3.0.0
+pytest-mock==3.6.1
+pytest-xdist==2.4.0

scripts/setup-commom.sh

@@ -0,0 +1,4 @@
+#!/usr/bin/env bash
+
+pip install --upgrade pip
+pip install -r requirements/requirements.txt

scripts/setup-venv.sh

@@ -0,0 +1,10 @@
+#!/usr/bin/env bash
+
+if [ ! -d venv ]; then
+    mkdir venv
+    python3 -m venv venv
+fi
+
+source venv/bin/activate
+pip install --upgrade pip
+pip install -r requirements/requirements.txt

scripts/start-app.sh

@@ -0,0 +1,20 @@
+#!/usr/bin/env bash
+
+if [ "$1" == "-h" ]; then
+	echo "This script will create an app inside the apps folder"
+	echo "To use type the following line:"
+	echo "bash start-app.sh app_name"
+	echo "Replace app_name with the actual name for your app"
+elif [ "$1" != "" ]; then
+    if [ ! -d "apps" ]; then
+        mkdir apps
+        touch apps/__init__.py
+    fi
+    mkdir apps/$1
+    python manage.py startapp $1 apps/$1 --template conf/app_template
+    if [ -f "apps/$1/__init__.py" ]; then
+        echo "Success! The app $1 has been added, don't forget to add INSTALLED_APPS += ['apps.$1.config.AppNameConfig'] in your project's settings.py"
+    fi
+else
+	echo "Error! One parameter is expected: app_name"
+fi