set up project template

Author: oscarychen

.gitignore

@@ -0,0 +1,150 @@
+data/
+environment/
+whoosh/
+activate*.sh
+activate*.bat
+
+run.bat
+node_modules/
+frontend/package-lock.json
+*.elasticbeanstalk/
+env/
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+*.sqlite3
+*.sqlite3-journal
+secrets/
+.vscode/
+.DS_Store
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+/.pnp
+.pnp.js
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+package/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+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/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+.hypothesis/
+.pytest_cache/
+/coverage
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# production
+/build
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# pyenv
+.python-version
+
+# celery beat schedule file
+celerybeat-schedule
+
+# 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/
+
+# VS Code workspace
+*.code-workspace
+# Elastic Beanstalk Files
+.elasticbeanstalk/*
+!.elasticbeanstalk/*.cfg.yml
+!.elasticbeanstalk/*.global.yml
+
+# csv files exported
+NOTE*.csv
+
+.idea
+.pylintrc

README.md

@@ -0,0 +1,3 @@
+# django-rest-microservice
+
+This is a place holder for work currently in progress and not yet published.

env_setup.sh

@@ -0,0 +1,41 @@
+
+#!/bin/bash
+
+echo "Removing existing environment/ directory..."
+rm -r environment
+
+echo "Creating new environment at environment/ ..."
+python3 -m venv environment/
+
+if [[ "$OSTYPE" == "msys"* ]]
+then
+	ENVPATH="environment/Scripts/activate"
+elif [[ "$OSTYPE" == "cygwin"* ]]
+then
+	ENVPATH="environment/Scripts/activate"
+	COMMENT_SYNTAX="rem"
+elif [[ "$OSTYPE" == "win32"* ]]
+then
+	ENVPATH="environment/Scripts/activate"
+else
+	ENVPATH="environment/bin/activate"
+fi
+
+echo "Installing python packages to environment at $ENVPATH ..."
+source $ENVPATH
+python3 -m pip install --upgrade pip
+python3 -m pip install -r requirements.txt
+deactivate
+
+echo "Creating activate.sh..."
+touch activate.sh
+echo > activate.sh
+echo "# Created by env_setup.sh, modify the environment variables below if needed.">>activate.sh
+echo "source $ENVPATH">> activate.sh
+echo >> activate.sh
+
+echo 'Finished setting up environment.'
+echo 'To activate environment, run `source activate.sh`.'
+
+
+

make_package_migrations.py

@@ -0,0 +1,49 @@
+#!environment/bin/python
+
+"""
+Use this script to create migrations for this standalone package.Remember to update references to model outside this
+package (such as auth user model) manually by editing the generated migrations files. See printout instruction below.
+"""
+
+import django
+from django.conf import settings
+from django.core.management import call_command
+
+settings.configure(
+    DEBUG=True,
+    INSTALLED_APPS=(
+        'django.contrib.contenttypes',
+        'django.contrib.auth',
+        'django_microservice',
+    ),
+)
+
+django.setup()
+call_command('makemigrations', )
+
+print('''
+Finished generating migrations.
+Check the migration file, update any reference to existing user model. Ie:
+
+(1) Instead of
+    ```
+        dependencies = [
+                ('auth', '0012_alter_user_first_name_max_length'),
+            ]
+    ```
+    Change it to:
+    ```
+        dependencies = [
+              migrations.swappable_dependency(settings.AUTH_USER_MODEL),
+            ]
+    ```
+
+(2) In fields, instead of referring to user model as
+    ```
+        'auth.user'
+    ```
+    change it to 
+    ```
+        settings.AUTH_USER_MODEL
+    ```
+''')

requirements.txt

@@ -0,0 +1,5 @@
+django>=2.2
+djangorestframework>=3.10
+djangorestframework-simplejwt>=5.0
+tox>=3.24
+wheel>=0.37

rest_framework_microservice/__init__.py

@@ -0,0 +1,5 @@
+from django.apps import AppConfig
+
+
+class RestFrameworkMicroserviceConfig(AppConfig):
+    name = 'rest_framework_microservice'

rest_framework_microservice/apps.py

@@ -0,0 +1,58 @@
+from django.conf import settings
+from django.test.signals import setting_changed
+
+USER_SETTINGS = getattr(settings, "REST_FRAMEWORK_MICROSERVICE", None)
+
+DEFAULTS = {
+    "TOKEN_CUSTOM_USER_CLAIMS":  [],
+
+}
+
+
+class RestFrameworkMicroserviceSettings:
+    def __init__(self, user_settings=None, defaults=None):
+        self._user_settings = user_settings or {}
+        self.defaults = defaults or DEFAULTS
+        self._cached_attrs = set()
+
+    @property
+    def user_settings(self):
+        if not hasattr(self, "_user_settings"):
+            self._user_settings = getattr(settings, "REST_FRAMEWORK_MICROSERVICE", {})
+        return self._user_settings
+
+    def __getattr__(self, attr):
+
+        # check the setting is accepted
+        if attr not in self.defaults:
+            raise AttributeError(f"Invalid REST_FRAMEWORK_MICROSERVICE setting: {attr}")
+
+        # get from user settings or default value
+        try:
+            val = self.user_settings[attr]
+        except KeyError:
+            val = self.defaults[attr]
+
+        self._cached_attrs.add(attr)
+        setattr(self, attr, val)
+        return val
+
+    def reload(self):
+        for attr in self._cached_attrs:
+            delattr(self, attr)
+        self._cached_attrs.clear()
+        if hasattr(self, "_user_settings"):
+            delattr(self, "_user_settings")
+
+
+drf_stripe_settings = DrfStripeSettings(USER_SETTINGS, DEFAULTS)
+
+
+def reload_rest_framework_microservice_settings(*args, **kwargs):
+    print("Reloading rest_framework_microservice settings")
+    setting = kwargs["setting"]
+    if setting == "REST_FRAMEWORK_MICROSERVICE":
+        drf_stripe_settings.reload()
+
+
+setting_changed.connect(reload_rest_framework_microservice_settings)

rest_framework_microservice/settings.py

@@ -0,0 +1,36 @@
+[metadata]
+name = django-rest-microservice
+version = 0
+description = Facilitating microservice architecture in Django REST framework
+long_description = file: README.md
+url = https://github.com/oscarychen/django-rest-microservice
+author = Oscar Chen
+author_email = quacky@duck.com
+license = MIT
+classifiers =
+    Environment :: Web Environment
+    Framework :: Django
+    Framework :: Django :: 3.0
+    Framework :: Django :: 3.1
+    Framework :: Django :: 3.2
+    Framework :: Django :: 4.0
+    Intended Audience :: Developers
+    License :: OSI Approved :: BSD License
+    Operating System :: OS Independent
+    Programming Language :: Python
+    Programming Language :: Python :: 3
+    Programming Language :: Python :: 3 :: Only
+    Programming Language :: Python :: 3.6
+    Programming Language :: Python :: 3.7
+    Programming Language :: Python :: 3.8
+    Programming Language :: Python :: 3.9
+    Topic :: Internet :: WWW/HTTP
+    Topic :: Internet :: WWW/HTTP :: Dynamic Content
+
+[options]
+include_package_data = true
+packages = find:
+python_requires = >=3.6
+install_requires =
+    Django >= 2.2
+    djangorestframework >= 3.0

setup.cfg

@@ -0,0 +1,6 @@
+from setuptools import setup, find_packages
+
+setup(
+    long_description_content_type='text/markdown',
+    packages=find_packages(exclude=("tests",)),
+)