commit e4777fc696a4b52d988899b33b7ccc5e8e733289 Author: Devoalda Date: Mon Oct 23 11:11:14 2023 +0800 Initial commit diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..7c3237d --- /dev/null +++ b/.gitignore @@ -0,0 +1,231 @@ +### venv template +# Virtualenv +# http://iamzed.com/2009/05/07/a-primer-on-virtualenv/ +.Python +[Bb]in +[Ii]nclude +[Ll]ib +[Ll]ib64 +[Ll]ocal +[Ss]cripts +pyvenv.cfg +.venv +pip-selfcheck.json + +### Example user template template +### Example user template + +# IntelliJ project files +.idea +*.iml +out +gen +### react template +.DS_* +*.log +logs +**/*.backup.* +**/*.back.* + +node_modules +bower_components + +*.sublime* + +psd +thumb +sketch + +### Zsh template +# Zsh compiled script + zrecompile backup +*.zwc +*.zwc.old + +# Zsh completion-optimization dumpfile +*zcompdump* + +# Zsh history +.zsh_history + +# Zsh sessions +.zsh_sessions + +# Zsh zcalc history +.zcalc_history + +# A popular plugin manager's files +._zinit +.zinit_lstupd + +# zdharma/zshelldoc tool's files +zsdoc/data + +# robbyrussell/oh-my-zsh/plugins/per-directory-history plugin's files +# (when set-up to store the history in the local directory) +.directory_history + +# MichaelAquilina/zsh-autoswitch-virtualenv plugin's files +# (for Zsh plugins using Python) + +# Zunit tests' output +/tests/_output/* +!/tests/_output/.gitkeep + +### Python template +# Byte-compiled / optimized / DLL files +__pycache__/ +*.py[cod] +*$py.class + +# C extensions +*.so + +# Distribution / packaging +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: +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 +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/ \ No newline at end of file diff --git a/safeshare/env b/safeshare/env new file mode 100644 index 0000000..a89e3e2 --- /dev/null +++ b/safeshare/env @@ -0,0 +1,21 @@ +# Copy to .env file and edit as needed + +DEBUG=True +SECRET_KEY=your-secret-key + +# MYSQL DATABASE +DB_NAME=your-db-name +DB_USER=your-db-user +DB_PASSWORD=your-db-password +DB_HOST=localhost +DB_PORT=3306 + +# CACHE (REDIS) +CACHE=True +REDIS_URL=redis://localhost:6379/0 + +# SQLITE_URL=sqlite:///my-local-sqlite.db +# CACHE_URL=memcache://127.0.0.1:11211,127.0.0.1:11212,127.0.0.1:11213 +CACHE=TRUE +REDIS_URL=redis://127.0.0.1:6379/1 + diff --git a/safeshare/manage.py b/safeshare/manage.py new file mode 100755 index 0000000..0ba7758 --- /dev/null +++ b/safeshare/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', 'safeshare.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/safeshare/requirements.txt b/safeshare/requirements.txt new file mode 100644 index 0000000..5bf9d2d --- /dev/null +++ b/safeshare/requirements.txt @@ -0,0 +1,37 @@ +annotated-types==0.5.0 +argon2-cffi==23.1.0 +argon2-cffi-bindings==21.2.0 +asgiref==3.7.2 +certifi==2023.7.22 +cffi==1.16.0 +charset-normalizer==3.2.0 +Django==4.2.5 +django-cors-headers==4.3.0 +django-environ==0.11.2 +djangorestframework==3.14.0 +djangorestframework-jwt==1.11.0 +djangorestframework-simplejwt==5.3.0 +dr-scaffold==2.1.2 +drf-nested-routers==0.93.4 +drf-yasg==1.21.7 +idna==3.4 +inflect==7.0.0 +inflection==0.5.1 +install==1.3.5 +isort==5.12.0 +mysqlclient==2.2.0 +packaging==23.2 +psycopg2-binary==2.9.9 +pycparser==2.21 +pydantic==2.4.2 +pydantic_core==2.10.1 +PyJWT==1.7.1 +PyMySQL==1.1.0 +pytz==2023.3.post1 +PyYAML==6.0.1 +redis==5.0.1 +requests==2.31.0 +sqlparse==0.4.4 +typing_extensions==4.8.0 +uritemplate==4.1.1 +urllib3==2.0.5 diff --git a/safeshare/safeshare/__init__.py b/safeshare/safeshare/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/safeshare/safeshare/asgi.py b/safeshare/safeshare/asgi.py new file mode 100644 index 0000000..76fb6c6 --- /dev/null +++ b/safeshare/safeshare/asgi.py @@ -0,0 +1,16 @@ +""" +ASGI config for safeshare 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.2/howto/deployment/asgi/ +""" + +import os + +from django.core.asgi import get_asgi_application + +os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'safeshare.settings') + +application = get_asgi_application() diff --git a/safeshare/safeshare/settings.py b/safeshare/safeshare/settings.py new file mode 100644 index 0000000..b9f9d15 --- /dev/null +++ b/safeshare/safeshare/settings.py @@ -0,0 +1,198 @@ +""" +Django settings for safeshare project. + +Generated by 'django-admin startproject' using Django 4.2.6. + +For more information on this file, see +https://docs.djangoproject.com/en/4.2/topics/settings/ + +For the full list of settings and their values, see +https://docs.djangoproject.com/en/4.2/ref/settings/ +""" + +from datetime import timedelta +from pathlib import Path +import environ +import os + +env = environ.Env( + # set casting, default value + DEBUG=(bool, False) +) + +# Build paths inside the project like this: BASE_DIR / 'subdir'. +BASE_DIR = Path(__file__).resolve().parent.parent + +environ.Env.read_env(os.path.join(BASE_DIR, '.env')) + +# Quick-start development settings - unsuitable for production +# See https://docs.djangoproject.com/en/4.2/howto/deployment/checklist/ + +# SECURITY WARNING: keep the secret key used in production secret! +SECRET_KEY = env('SECRET_KEY', default='django-insecure-j-35kvg#frf3@swdljf8(f0%!j4-1=%2-9v7q4+ek(aj&5-#yw') + +# SECURITY WARNING: don't run with debug turned on in production! +DEBUG = env('DEBUG', default=False) + +ALLOWED_HOSTS = env.list('ALLOWED_HOSTS', default=['*']) + + +# Application definition + +INSTALLED_APPS = [ + 'django.contrib.admin', + 'django.contrib.auth', + 'django.contrib.contenttypes', + 'django.contrib.sessions', + 'django.contrib.messages', + 'django.contrib.staticfiles', + 'rest_framework', + 'corsheaders', + 'drf_yasg', + 'safeshare_app', +] + +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', + 'corsheaders.middleware.CorsMiddleware', +] + +ROOT_URLCONF = 'safeshare.urls' + +REST_FRAMEWORK = { + 'DEFAULT_PERMISSION_CLASSES': ( + 'rest_framework.permissions.IsAuthenticated', + ), + 'DEFAULT_AUTHENTICATION_CLASSES': ( + 'rest_framework_simplejwt.authentication.JWTAuthentication', + 'rest_framework.authentication.SessionAuthentication', + 'rest_framework.authentication.BasicAuthentication', + ), +} +SIMPLE_JWT = { + 'ACCESS_TOKEN_LIFETIME': timedelta(minutes=10), + 'REFRESH_TOKEN_LIFETIME': timedelta(days=7), + "ROTATE_REFRESH_TOKENS": True, + "BLACKLIST_AFTER_ROTATION": True, + "ALGORITHM": "HS256", + "SIGNING_KEY": SECRET_KEY, + "VERIFYING_KEY": None, + "USER_ID_FIELD": "id", + "USER_ID_CLAIM": "user_id", + "AUTH_TOKEN_CLASSES": ("rest_framework_simplejwt.tokens.AccessToken",), + "TOKEN_TYPE_CLAIM": "token_type", +} + +CORS_ALLOWED_ORIGINS = [ + 'http://localhost:3000', +] +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 = 'safeshare.wsgi.application' + +# Database +# https://docs.djangoproject.com/en/4.2/ref/settings/#databases + +if os.getenv('GITHUB_WORKFLOW'): + DATABASES = { + 'default': { + 'ENGINE': 'django.db.backends.postgresql', + 'NAME': 'github-actions', + 'USER': 'postgres', + 'PASSWORD': 'postgres', + 'HOST': 'localhost', + 'PORT': '5432' + } + } +else: + DATABASES = { + 'default': { + 'ENGINE': 'django.db.backends.mysql', + 'NAME': env.str('DB_NAME', 'safeshare'), + 'USER': env.str('DB_USER', 'mariadb'), + 'PASSWORD': env.str('DB_PASSWORD', 'mariadb'), + 'HOST': env.str('DB_HOST', 'localhost'), + 'PORT': env.str('DB_PORT', '3306'), + 'OPTIONS': { + 'init_command': "SET sql_mode='STRICT_TRANS_TABLES', innodb_strict_mode=1", + }, + } + } + +if env.bool('CACHE', default=False): + CACHES = { + "default": { + "BACKEND": "django.core.cache.backends.redis.RedisCache", + "LOCATION": env.str('REDIS_URL', 'redis://localhost:6379/1'), + } + } + + +PASSWORD_HASHERS = [ + "django.contrib.auth.hashers.Argon2PasswordHasher", + "django.contrib.auth.hashers.PBKDF2PasswordHasher", + "django.contrib.auth.hashers.PBKDF2SHA1PasswordHasher", + "django.contrib.auth.hashers.BCryptSHA256PasswordHasher", + "django.contrib.auth.hashers.ScryptPasswordHasher", +] + +# Password validation +# https://docs.djangoproject.com/en/4.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/4.2/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.2/howto/static-files/ + +STATIC_URL = 'static/' + +# Default primary key field type +# https://docs.djangoproject.com/en/4.2/ref/settings/#default-auto-field + +DEFAULT_AUTO_FIELD = 'django.db.models.BigAutoField' diff --git a/safeshare/safeshare/urls.py b/safeshare/safeshare/urls.py new file mode 100644 index 0000000..6c27924 --- /dev/null +++ b/safeshare/safeshare/urls.py @@ -0,0 +1,22 @@ +""" +URL configuration for safeshare project. + +The `urlpatterns` list routes URLs to views. For more information please see: + https://docs.djangoproject.com/en/4.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), +] diff --git a/safeshare/safeshare/wsgi.py b/safeshare/safeshare/wsgi.py new file mode 100644 index 0000000..43e79b8 --- /dev/null +++ b/safeshare/safeshare/wsgi.py @@ -0,0 +1,16 @@ +""" +WSGI config for safeshare 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.2/howto/deployment/wsgi/ +""" + +import os + +from django.core.wsgi import get_wsgi_application + +os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'safeshare.settings') + +application = get_wsgi_application() diff --git a/safeshare/safeshare_app/__init__.py b/safeshare/safeshare_app/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/safeshare/safeshare_app/admin.py b/safeshare/safeshare_app/admin.py new file mode 100644 index 0000000..8c38f3f --- /dev/null +++ b/safeshare/safeshare_app/admin.py @@ -0,0 +1,3 @@ +from django.contrib import admin + +# Register your models here. diff --git a/safeshare/safeshare_app/apps.py b/safeshare/safeshare_app/apps.py new file mode 100644 index 0000000..ae9c5ab --- /dev/null +++ b/safeshare/safeshare_app/apps.py @@ -0,0 +1,6 @@ +from django.apps import AppConfig + + +class SafeshareAppConfig(AppConfig): + default_auto_field = 'django.db.models.BigAutoField' + name = 'safeshare_app' diff --git a/safeshare/safeshare_app/migrations/__init__.py b/safeshare/safeshare_app/migrations/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/safeshare/safeshare_app/models.py b/safeshare/safeshare_app/models.py new file mode 100644 index 0000000..71a8362 --- /dev/null +++ b/safeshare/safeshare_app/models.py @@ -0,0 +1,3 @@ +from django.db import models + +# Create your models here. diff --git a/safeshare/safeshare_app/tests.py b/safeshare/safeshare_app/tests.py new file mode 100644 index 0000000..7ce503c --- /dev/null +++ b/safeshare/safeshare_app/tests.py @@ -0,0 +1,3 @@ +from django.test import TestCase + +# Create your tests here. diff --git a/safeshare/safeshare_app/views.py b/safeshare/safeshare_app/views.py new file mode 100644 index 0000000..91ea44a --- /dev/null +++ b/safeshare/safeshare_app/views.py @@ -0,0 +1,3 @@ +from django.shortcuts import render + +# Create your views here.