From 97ae2056e53c87faaa0349bbfff3bff5f23956bb Mon Sep 17 00:00:00 2001 From: Reckless-Satoshi Date: Sat, 1 Jan 2022 10:53:17 -0800 Subject: [PATCH] Initialize the Django project and write setup guide --- .editorconfig | 10 ++-- manage.py | 22 ++++++++ robosats/__init__.py | 0 robosats/asgi.py | 16 ++++++ robosats/settings.py | 123 +++++++++++++++++++++++++++++++++++++++++++ robosats/urls.py | 21 ++++++++ robosats/wsgi.py | 16 ++++++ setup.md | 28 ++++++++++ 8 files changed, 232 insertions(+), 4 deletions(-) create mode 100755 manage.py create mode 100644 robosats/__init__.py create mode 100644 robosats/asgi.py create mode 100644 robosats/settings.py create mode 100644 robosats/urls.py create mode 100644 robosats/wsgi.py create mode 100644 setup.md diff --git a/.editorconfig b/.editorconfig index d34c9f2c..78445d12 100755 --- a/.editorconfig +++ b/.editorconfig @@ -9,12 +9,14 @@ trim_trailing_whitespace = true insert_final_newline = true # 4 space indentation -[*.py] +[*.{py,rst,ini}] indent_style = space indent_size = 4 - # 2 space indentation -[*.js] +[*.{html,css,scss,json,yml}] indent_style = space -indent_size = 2 \ No newline at end of file +indent_size = 2 + +[*.md] +trim_trailing_whitespace = false \ No newline at end of file diff --git a/manage.py b/manage.py new file mode 100755 index 00000000..047fb189 --- /dev/null +++ b/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', 'robosats.settings') + 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() diff --git a/robosats/__init__.py b/robosats/__init__.py new file mode 100644 index 00000000..e69de29b diff --git a/robosats/asgi.py b/robosats/asgi.py new file mode 100644 index 00000000..e4577ea2 --- /dev/null +++ b/robosats/asgi.py @@ -0,0 +1,16 @@ +""" +ASGI config for robosats 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/4.0/howto/deployment/asgi/ +""" + +import os + +from django.core.asgi import get_asgi_application + +os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'robosats.settings') + +application = get_asgi_application() diff --git a/robosats/settings.py b/robosats/settings.py new file mode 100644 index 00000000..c50c5079 --- /dev/null +++ b/robosats/settings.py @@ -0,0 +1,123 @@ +""" +Django settings for robosats project. + +Generated by 'django-admin startproject' using Django 4.0. + +For more information on this file, see +https://docs.djangoproject.com/en/4.0/topics/settings/ + +For the full list of settings and their values, see +https://docs.djangoproject.com/en/4.0/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/4.0/howto/deployment/checklist/ + +# SECURITY WARNING: keep the secret key used in production secret! +SECRET_KEY = 'django-insecure-6^&6uw$b5^en%(cu2kc7_o)(mgpazx#j_znwlym0vxfamn2uo-' + +# SECURITY WARNING: don't run with debug turned on in production! +DEBUG = True + +ALLOWED_HOSTS = [] + + +# Application definition + +INSTALLED_APPS = [ + 'django.contrib.admin', + 'django.contrib.auth', + 'django.contrib.contenttypes', + 'django.contrib.sessions', + 'django.contrib.messages', + 'django.contrib.staticfiles', +] + +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 = 'robosats.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 = 'robosats.wsgi.application' + + +# Database +# https://docs.djangoproject.com/en/4.0/ref/settings/#databases + +DATABASES = { + 'default': { + 'ENGINE': 'django.db.backends.sqlite3', + 'NAME': BASE_DIR / 'db.sqlite3', + } +} + + +# Password validation +# https://docs.djangoproject.com/en/4.0/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/4.0/topics/i18n/ + +LANGUAGE_CODE = 'en-us' + +TIME_ZONE = 'UTC' + +USE_I18N = True + +USE_TZ = True + + +# Static files (CSS, JavaScript, Images) +# https://docs.djangoproject.com/en/4.0/howto/static-files/ + +STATIC_URL = 'static/' + +# Default primary key field type +# https://docs.djangoproject.com/en/4.0/ref/settings/#default-auto-field + +DEFAULT_AUTO_FIELD = 'django.db.models.BigAutoField' diff --git a/robosats/urls.py b/robosats/urls.py new file mode 100644 index 00000000..83b304db --- /dev/null +++ b/robosats/urls.py @@ -0,0 +1,21 @@ +"""robosats URL Configuration + +The `urlpatterns` list routes URLs to views. For more information please see: + https://docs.djangoproject.com/en/4.0/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), +] diff --git a/robosats/wsgi.py b/robosats/wsgi.py new file mode 100644 index 00000000..b37f599a --- /dev/null +++ b/robosats/wsgi.py @@ -0,0 +1,16 @@ +""" +WSGI config for robosats 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/4.0/howto/deployment/wsgi/ +""" + +import os + +from django.core.wsgi import get_wsgi_application + +os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'robosats.settings') + +application = get_wsgi_application() diff --git a/setup.md b/setup.md new file mode 100644 index 00000000..1701a706 --- /dev/null +++ b/setup.md @@ -0,0 +1,28 @@ +# Set up +## Django development environment +### Install Python and pip +`sudo apt install python3 python3 pip` + +### Install virtual environments +`pip install virtualenvwrapper` + +### Add to .bashrc +`export WORKON_HOME=$HOME/.virtualenvs +export VIRTUALENVWRAPPER_PYTHON=/usr/bin/python3 +export VIRTUALENVWRAPPER_VIRTUALENV_ARGS=' -p /usr/bin/python3 ' +export PROJECT_HOME=$HOME/Devel +source /usr/local/bin/virtualenvwrapper.sh` + +### Reload startup file +`source ~/.bashrc` + +### Create virtual environment +`mkvirtualenv robosats_env` + +### Activate environment +`workon robosats_env` + +### Install Django and Restframework +`pip3 install django djangorestframework` + +*Django 4.0 at the time of writting*