From 6670ddd9f052f439b5a5fa9cf5ccd3331fe3e28d Mon Sep 17 00:00:00 2001 From: Saket Date: Fri, 3 Jun 2022 00:31:31 +0530 Subject: [PATCH] feat(api): base code for api --- .gitignore | 37 ------ api/.gitignore | 162 ++++++++++++++++++++++++++ api/{.gitpresence => api/__init__.py} | 0 api/api/asgi.py | 16 +++ api/api/settings.py | 116 ++++++++++++++++++ api/api/tests.py | 12 ++ api/api/urls.py | 8 ++ api/api/views.py | 7 ++ api/api/wsgi.py | 16 +++ api/manage.py | 24 ++++ api/requirements.txt | 11 ++ 11 files changed, 372 insertions(+), 37 deletions(-) delete mode 100644 .gitignore create mode 100644 api/.gitignore rename api/{.gitpresence => api/__init__.py} (100%) create mode 100644 api/api/asgi.py create mode 100644 api/api/settings.py create mode 100644 api/api/tests.py create mode 100644 api/api/urls.py create mode 100644 api/api/views.py create mode 100644 api/api/wsgi.py create mode 100755 api/manage.py create mode 100644 api/requirements.txt diff --git a/.gitignore b/.gitignore deleted file mode 100644 index 9e3d78f..0000000 --- a/.gitignore +++ /dev/null @@ -1,37 +0,0 @@ -# See https://help.github.com/ignore-files/ for more about ignoring files. - -# dependencies -ui/node_modules - -# testing -ui/coverage - -# production -ui/build - -# misc -.DS_Store -.env -env -venv - -npm-debug.log* -yarn-debug.log* -yarn-error.log* - - -*.lock -*.lock.json - - -*.pyc -__pycache__ -migrations -db.sqlite3 - -.project -.pydevproject -.settings -.vscode -.coverage -htmlcov diff --git a/api/.gitignore b/api/.gitignore new file mode 100644 index 0000000..42eb5be --- /dev/null +++ b/api/.gitignore @@ -0,0 +1,162 @@ +# Byte-compiled / optimized / DLL files +__pycache__/ +*.py[cod] +*$py.class + +# C extensions +*.so + +# Distribution / packaging +.Python +build/ +develop-eggs/ +dist/ +downloads/ +eggs/ +.eggs/ +lib/ +lib64/ +parts/ +sdist/ +var/ +wheels/ +share/python-wheels/ +*.egg-info/ +.installed.cfg +*.egg +MANIFEST + +# PyInstaller +# Usually these files are written by a python script from a template +# before PyInstaller builds the exe, so as to inject date/other infos into it. +*.manifest +*.spec + +# Installer logs +pip-log.txt +pip-delete-this-directory.txt + +# Unit test / coverage reports +htmlcov/ +.tox/ +.nox/ +.coverage +.coverage.* +.cache +nosetests.xml +coverage.xml +*.cover +*.py,cover +.hypothesis/ +.pytest_cache/ +cover/ + +# Translations +*.mo +*.pot + +# Django stuff: +*.log +local_settings.py +db.sqlite3 +db.sqlite3-journal + +# Flask stuff: +instance/ +.webassets-cache + +# Scrapy stuff: +.scrapy + +# Sphinx documentation +docs/_build/ + +# PyBuilder +.pybuilder/ +target/ + +# Jupyter Notebook +.ipynb_checkpoints + +# IPython +profile_default/ +ipython_config.py + +# pyenv +# For a library or package, you might want to ignore these files since the code is +# intended to run in multiple environments; otherwise, check them in: +# .python-version + +# pipenv +# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. +# However, in case of collaboration, if having platform-specific dependencies or dependencies +# having no cross-platform support, pipenv may install dependencies that don't work, or not +# install all needed dependencies. +#Pipfile.lock + +# poetry +# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control. +# This is especially recommended for binary packages to ensure reproducibility, and is more +# commonly ignored for libraries. +# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control +#poetry.lock + +# pdm +# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control. +#pdm.lock +# pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it +# in version control. +# https://pdm.fming.dev/#use-with-ide +.pdm.toml + +# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm +__pypackages__/ + +# Celery stuff +celerybeat-schedule +celerybeat.pid + +# SageMath parsed files +*.sage.py + +# Environments +.env +.venv +env/ +venv/ +ENV/ +env.bak/ +venv.bak/ + +# Spyder project settings +.spyderproject +.spyproject + +# Rope project settings +.ropeproject + +# mkdocs documentation +/site + +# mypy +.mypy_cache/ +.dmypy.json +dmypy.json + +# Pyre type checker +.pyre/ + +# pytype static type analyzer +.pytype/ + +# Cython debug symbols +cython_debug/ + +# PyCharm +# JetBrains specific template is maintained in a separate JetBrains.gitignore that can +# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore +# and can be added to the global gitignore or merged into this file. For a more nuclear +# option (not recommended) you can uncomment the following to ignore the entire idea folder. +#.idea/ + +pyrightconfig.json diff --git a/api/.gitpresence b/api/api/__init__.py similarity index 100% rename from api/.gitpresence rename to api/api/__init__.py diff --git a/api/api/asgi.py b/api/api/asgi.py new file mode 100644 index 0000000..40b0b55 --- /dev/null +++ b/api/api/asgi.py @@ -0,0 +1,16 @@ +""" +ASGI config for api 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', 'api.settings') + +application = get_asgi_application() diff --git a/api/api/settings.py b/api/api/settings.py new file mode 100644 index 0000000..142339f --- /dev/null +++ b/api/api/settings.py @@ -0,0 +1,116 @@ +""" +Django settings for api project. + +Generated by 'django-admin startproject' using Django 4.0.5. + +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/ +""" + +import os +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 = os.environ.get('PROJECT_SECRET_KEY', '') + +# SECURITY WARNING: don't run with debug turned on in production! +DEBUG = True + +ALLOWED_HOSTS = [] + + +# Application definition + +INSTALLED_APPS = [ + 'django.contrib.auth', + 'django.contrib.contenttypes', + 'django.contrib.sessions', + 'django.contrib.messages', + 'django.contrib.staticfiles', + + 'rest_framework', +] + +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', +] + +REST_FRAMEWORK = { + 'TEST_REQUEST_DEFAULT_FORMAT': 'json', + 'TEST_REQUEST_RENDERER_CLASSES': [ + 'rest_framework.renderers.JSONRenderer' + ] +} + +ROOT_URLCONF = 'api.urls' + +WSGI_APPLICATION = 'api.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/api/api/tests.py b/api/api/tests.py new file mode 100644 index 0000000..f5cd62b --- /dev/null +++ b/api/api/tests.py @@ -0,0 +1,12 @@ +from rest_framework import status +from rest_framework.test import APITestCase + + +class PingTest(APITestCase): + def test_ping(self): + """Tests the /ping/ endpoint to return message: 'Up'""" + url = '/ping/' + + response = self.client.get(url) + self.assertEqual(response.status_code, status.HTTP_200_OK) + self.assertEqual(response.data, {'message': 'Up'}) diff --git a/api/api/urls.py b/api/api/urls.py new file mode 100644 index 0000000..d26e2d5 --- /dev/null +++ b/api/api/urls.py @@ -0,0 +1,8 @@ +from django.urls import path +from django.urls.conf import include +from .views import ping_handler + +urlpatterns = [ + path('ping/', ping_handler, name='ping'), + path('api-auth/', include('rest_framework.urls', namespace='rest_framework')) +] diff --git a/api/api/views.py b/api/api/views.py new file mode 100644 index 0000000..8a292af --- /dev/null +++ b/api/api/views.py @@ -0,0 +1,7 @@ +from rest_framework.decorators import api_view +from rest_framework.response import Response + + +@api_view(['GET']) +def ping_handler(request): + return Response({'message': 'Up'}) diff --git a/api/api/wsgi.py b/api/api/wsgi.py new file mode 100644 index 0000000..77ff2d5 --- /dev/null +++ b/api/api/wsgi.py @@ -0,0 +1,16 @@ +""" +WSGI config for api 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', 'api.settings') + +application = get_wsgi_application() diff --git a/api/manage.py b/api/manage.py new file mode 100755 index 0000000..ff25273 --- /dev/null +++ b/api/manage.py @@ -0,0 +1,24 @@ +#!/usr/bin/env python3 +"""Django's command-line utility for administrative tasks.""" +import os +import sys +from dotenv import load_dotenv + + +def main(): + """Run administrative tasks.""" + load_dotenv() + os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'api.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/api/requirements.txt b/api/requirements.txt new file mode 100644 index 0000000..38951a3 --- /dev/null +++ b/api/requirements.txt @@ -0,0 +1,11 @@ +asgiref==3.5.2 +autopep8==1.6.0 +backports.zoneinfo==0.2.1 +Django==4.0.5 +djangorestframework==3.13.1 +djangorestframework-types==0.7.0 +pycodestyle==2.8.0 +python-dotenv==0.20.0 +pytz==2022.1 +sqlparse==0.4.2 +toml==0.10.2