Merge pull request #12 from iamjazzar/tests

Tests

Author: iamjazzar

.circleci/config.yml

@@ -0,0 +1,3 @@
+[flake8]
+exclude = .git,__pycache__,docs,migrations,node_modules,config,deploy
+max-line-length = 88

.flake8

@@ -0,0 +1,22 @@
+name: Tests
+on: [push]
+
+jobs:
+  tests:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.7", "3.8", "3.9", "3.10"]
+        tox-env: [py3, flake8, black, bandit, isort]
+    steps:
+      - uses: actions/checkout@v1
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v2
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install Dependencies
+        run: |
+          python -m pip install --upgrade pip setuptools
+          python -m pip install virtualenv tox tox-gh-actions wheel
+      - name: "Run tox targets for ${{ matrix.python-version }}"
+        run: "tox -e ${{ matrix.tox-env }}"

.github/workflows/pull_request.yml

@@ -0,0 +1,33 @@
+# This workflow will upload a Python Package using Twine when a release is created
+# For more information see: https://help.github.com/en/actions/language-and-framework-guides/using-python-with-github-actions#publishing-to-package-registries
+
+name: Python packaging for pip
+
+on:
+  pull_request:
+  release:
+    types: [published]
+
+jobs:
+  deploy:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Python
+      uses: actions/setup-python@v3
+      with:
+        python-version: '3.x'
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install build
+    - name: Build package
+      run: python -m build
+    - name: Publish package for GitHub releases
+      uses: pypa/gh-action-pypi-publish@27b31702a0e7fc50959f5ad993c78deac1bdfc29
+      if: ${{ startsWith(github.ref, 'refs/tags') }}
+      with:
+        user: __token__
+        password: ${{ secrets.PYPI_API_TOKEN }}

.github/workflows/python-publish.yml

@@ -1,9 +1,10 @@
-# django-mako [![CircleCI](https://circleci.com/gh/ahmedaljazzar/django-mako.svg?style=svg)](https://circleci.com/gh/ahmedaljazzar/django-mako)
+# django-mako [![Tests](https://github.com/iamjazzar/django-mako/actions/workflows/pull_request.yml/badge.svg)](https://github.com/iamjazzar/django-mako/actions/workflows/pull_request.yml)
+
 The simple, elegant Django Mako library
 Used base engine to create a template rendering class to be used like Django's TemplateView class. To understand how to use it, read [Custom backends on django](https://docs.djangoproject.com/en/1.8/topics/templates/#custom-backends).
 
-- The current implementation assumes all system templates are Mako Template. Thus, when you start a new template make sure that the template language is Mako not Django. 
-- If you want to use another template backend like Django Template Backend, just pass `using='Django'` in your FBV or add `template_engine = 'mako'` in your CBV. 
+- The current implementation assumes all system templates are Mako Template. Thus, when you start a new template make sure that the template language is Mako not Django.
+- If you want to use another template backend like Django Template Backend, just pass `using='Django'` in your FBV or add `template_engine = 'mako'` in your CBV.
 
 Enjoy! This shouldn't be tricky any more.
 
@@ -17,8 +18,8 @@ pip install djangomako
 
 
 ## Using the library
-After installing the package in your python environment, navigate to 
-your project's `settings.py` and add the following lines in the 
+After installing the package in your python environment, navigate to
+your project's `settings.py` and add the following lines in the
 `TEMPLATES` variable
 
 ```python
@@ -37,17 +38,17 @@ TEMPLATES = [
 
 - The `BACKEND` value is from this library.
 - The `NAME` is simply the template identifier.
-- In `DIRS` you're gonna include all the directories that have mako 
+- In `DIRS` you're gonna include all the directories that have mako
 templates.
-- The order matters here, so if you want your project to 
-support only mako, you just need to remove the Django entry from the 
+- The order matters here, so if you want your project to
+support only mako, you just need to remove the Django entry from the
 templates, while if you need mako as a fallback only, then you need to
 put it under the Django Template entry.
 
 
 #### Template Variables
 
-I passed some template variables to the context if the request objects 
+I passed some template variables to the context if the request objects
 exists:
 
 1. `CSRF_TOKEN` and `CSRF_INPUT`
@@ -69,15 +70,15 @@ exists:
     ```
 
 ## Detailed Examples?
-An example of how to use this library in Class-Based view and 
+An example of how to use this library in Class-Based view and
 Function-Based Views is inside [niceapp](https://github.com/ahmedaljazzar/django-mako/tree/master/niceapp)
 app.
 
 ## Errors?
 To test how this engine handles errors, just run theserver and go to this path [/mako]().
 
 ## Detailed Explanation?
-You can find a detailed explanation of how I implemented this library 
+You can find a detailed explanation of how I implemented this library
 in my blog post named [Integrating third-party templates' libraries with Django](https://ahmedjazzar.com/single-post/Mako-Django).
 
 ## License

README.md

@@ -0,0 +1,3 @@
+exclude_dirs:
+  - '/tests/'
+  - 'browser_tests.py'

bandit.yaml

@@ -20,7 +20,7 @@
 # See https://docs.djangoproject.com/en/1.11/howto/deployment/checklist/
 
 # SECURITY WARNING: keep the secret key used in production secret!
-SECRET_KEY = 'x@obtjzyg*%l!7v2u67ztd_)@cga(0bz1-tdl*2(cg&aj6*%&p'
+SECRET_KEY = "x@obtjzyg*%l!7v2u67ztd_)@cga(0bz1-tdl*2(cg&aj6*%&p"
 
 # SECURITY WARNING: don't run with debug turned on in production!
 DEBUG = True
@@ -31,62 +31,62 @@
 # Application definition
 
 INSTALLED_APPS = [
-    'django.contrib.admin',
-    'django.contrib.auth',
-    'django.contrib.contenttypes',
-    'django.contrib.sessions',
-    'django.contrib.messages',
-    'django.contrib.staticfiles',
+    "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',
+    "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 = 'config.urls'
+ROOT_URLCONF = "config.urls"
 
 TEMPLATES = [
     {
-        'BACKEND': 'django.template.backends.django.DjangoTemplates',
-        'NAME': 'django',
-        'DIRS': [
-            os.path.join(BASE_DIR, 'templates'),
+        "BACKEND": "django.template.backends.django.DjangoTemplates",
+        "NAME": "django",
+        "DIRS": [
+            os.path.join(BASE_DIR, "templates"),
         ],
-        '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',
+        "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",
             ],
         },
     },
     {
-        'BACKEND': 'djangomako.backends.MakoBackend',
-        'NAME': 'mako',
-        'DIRS': [
-            os.path.join(BASE_DIR, 'templates'),
+        "BACKEND": "djangomako.backends.MakoBackend",
+        "NAME": "mako",
+        "DIRS": [
+            os.path.join(BASE_DIR, "templates"),
         ],
     },
 ]
 
-WSGI_APPLICATION = 'config.wsgi.application'
+WSGI_APPLICATION = "config.wsgi.application"
 
 
 # Database
 # https://docs.djangoproject.com/en/1.11/ref/settings/#databases
 
 DATABASES = {
-    'default': {
-        'ENGINE': 'django.db.backends.sqlite3',
-        'NAME': os.path.join(BASE_DIR, 'db.sqlite3'),
+    "default": {
+        "ENGINE": "django.db.backends.sqlite3",
+        "NAME": os.path.join(BASE_DIR, "db.sqlite3"),
     }
 }
 
@@ -96,26 +96,26 @@
 
 AUTH_PASSWORD_VALIDATORS = [
     {
-        'NAME': 'django.contrib.auth.password_validation.UserAttributeSimilarityValidator',
+        "NAME": "django.contrib.auth.password_validation.UserAttributeSimilarityValidator",
     },
     {
-        'NAME': 'django.contrib.auth.password_validation.MinimumLengthValidator',
+        "NAME": "django.contrib.auth.password_validation.MinimumLengthValidator",
     },
     {
-        'NAME': 'django.contrib.auth.password_validation.CommonPasswordValidator',
+        "NAME": "django.contrib.auth.password_validation.CommonPasswordValidator",
     },
     {
-        'NAME': 'django.contrib.auth.password_validation.NumericPasswordValidator',
+        "NAME": "django.contrib.auth.password_validation.NumericPasswordValidator",
     },
 ]
 
 
 # Internationalization
 # https://docs.djangoproject.com/en/1.11/topics/i18n/
 
-LANGUAGE_CODE = 'en-us'
+LANGUAGE_CODE = "en-us"
 
-TIME_ZONE = 'UTC'
+TIME_ZONE = "UTC"
 
 USE_I18N = True
 
@@ -127,4 +127,4 @@
 # Static files (CSS, JavaScript, Images)
 # https://docs.djangoproject.com/en/1.11/howto/static-files/
 
-STATIC_URL = '/static/'
+STATIC_URL = "/static/"

config/settings.py

@@ -3,8 +3,8 @@
 from niceapp import views
 
 urlpatterns = [
-    re_path(r'^(?P<engine>django|mako)?$', views.function_based_view),
-    re_path(r'^class/(?P<engine>django|mako)?$',
-            views.ClassBasedView.as_view(),
-            name='CBV'),
+    re_path(r"^(?P<engine>django|mako)?$", views.function_based_view),
+    re_path(
+        r"^class/(?P<engine>django|mako)?$", views.ClassBasedView.as_view(), name="CBV"
+    ),
 ]