Add development tooling

Author: vsalvino

README.md

@@ -169,6 +169,25 @@ django-sass only depends on libsass (which provides pre-built wheels for Windows
 and Linux), and of course Django (any version).
 
 
+Contributing
+------------
+
+To set up a development environment, first check out this repository, create a
+venv, then:
+
+```
+(myvenv)$ pip install -e ./
+(myvenv)$ pip install -r requirements-dev.txt
+```
+
+Before committing, run static analysis tools:
+
+```
+(myvenv)$ flake8
+(myvenv)$ mypy
+```
+
+
 Changelog
 ---------
 

ci/compare-codecov.ps1

@@ -0,0 +1,108 @@
+#!/usr/bin/env pwsh
+
+<#
+.SYNOPSIS
+Compares code coverage percent of local coverage.xml file to master branch
+(Azure Pipeline API).
+
+.PARAMETER wd
+The working directory in which to search for current coverage.xml.
+
+.PARAMETER org
+Name of the Azure DevOps organization where the pipeline is hosted.
+
+.PARAMETER project
+Name of the Azure DevOps project to which the pipeline belongs.
+
+.PARAMETER pipeline_name
+Name of the desired pipeline within the project. This is to support projects
+with multiple pipelines.
+#>
+
+
+# ---- SETUP -------------------------------------------------------------------
+
+
+param(
+    [string] $wd = (Get-Item (Split-Path $PSCommandPath -Parent)).Parent,
+    [string] $org = "coderedcorp",
+    [string] $project = "coderedcms",
+    [string] $pipeline_name = "django-sass"
+)
+
+# Hide "UI" and progress bars.
+$ProgressPreference = "SilentlyContinue"
+
+# API setup.
+$ApiBase = "https://dev.azure.com/$org/$project"
+
+
+# ---- GET CODE COVERAGE FROM RECENT BUILD -------------------------------------
+
+
+# Get list of all recent builds.
+$masterBuildJson = (
+    Invoke-WebRequest "$ApiBase/_apis/build/builds?branchName=refs/heads/master&api-version=5.1"
+).Content | ConvertFrom-Json
+
+# Get the latest matching build ID from the list of builds.
+foreach ($build in $masterBuildJson.value) {
+    if ($build.definition.name -eq $pipeline_name) {
+        $masterLatestId = $build.id
+        break
+    }
+}
+
+# Retrieve code coverage for this build ID.
+$masterCoverageJson = (
+    Invoke-WebRequest "$ApiBase/_apis/test/codecoverage?buildId=$masterLatestId&api-version=5.1-preview.1"
+).Content | ConvertFrom-Json
+foreach ($cov in $masterCoverageJson.coverageData.coverageStats) {
+    if ($cov.label -eq "Lines") {
+        $masterlinerate = [math]::Round(($cov.covered / $cov.total) * 100, 2)
+    }
+}
+
+
+# ---- GET COVERAGE FROM LOCAL RUN ---------------------------------------------
+
+
+# Get current code coverage from coverage.xml file.
+$coveragePath = Get-ChildItem -Recurse -Filter "coverage.xml" $wd
+if (Test-Path -Path $coveragePath) {
+    [xml]$BranchXML = Get-Content $coveragePath
+}
+else {
+    Write-Host  -ForegroundColor Red `
+        "No code coverage from this build. Is pytest configured to output code coverage? Exiting."
+    exit 1
+}
+$branchlinerate = [math]::Round([decimal]$BranchXML.coverage.'line-rate' * 100, 2)
+
+
+# ---- PRINT OUTPUT ------------------------------------------------------------
+
+
+Write-Output ""
+Write-Output "Master line coverage rate:  $masterlinerate%"
+Write-Output "Branch line coverage rate:  $branchlinerate%"
+
+if ($masterlinerate -eq 0) {
+    $change = "Infinite"
+}
+else {
+    $change = [math]::Abs($branchlinerate - $masterlinerate)
+}
+
+if ($branchlinerate -gt $masterlinerate) {
+    Write-Host "Coverage increased by $change% 😀" -ForegroundColor Green
+    exit 0
+}
+elseif ($branchlinerate -eq $masterlinerate) {
+    Write-Host "Coverage has not changed." -ForegroundColor Green
+    exit 0
+}
+else {
+    Write-Host "Coverage decreased by $change% 😭" -ForegroundColor Red
+    exit 4
+}

django_sass/management/commands/sass.py

@@ -1,6 +1,7 @@
 import os
 import sys
 import time
+
 from django.core.management.base import BaseCommand
 from django.contrib.staticfiles.finders import get_finders
 import sass
@@ -50,9 +51,9 @@ def add_arguments(self, parser):
             help="Watch input path and re-generate css files when scss files are changed.",
         )
 
-    def compile_sass(self, outfile, **kwargs):
+    def compile_sass(self, outfile: str, **kwargs) -> None:
         rval = sass.compile(**kwargs)
-        # sass.compile() will return None of used with dirname.
+        # sass.compile() will return None if used with dirname.
         # If used with filename, it will return a string of file contents.
         if rval and outfile:
             # If we got a css and sourcemap tuple, write the sourcemap.
@@ -74,7 +75,7 @@ def compile_sass(self, outfile, **kwargs):
             file.write(rval)
             file.close()
 
-    def handle(self, *args, **options):
+    def handle(self, *args, **options) -> None:
         """
         Finds all static paths used by the project, and runs sass
         including those paths.
@@ -102,7 +103,9 @@ def handle(self, *args, **options):
             if os.path.isdir(outpath):
                 sassargs.update({"dirname": (inpath, outpath)})
             else:
-                raise NotADirectoryError("Output path must also be a directory when input path is a directory.")
+                raise NotADirectoryError(
+                    "Output path must also be a directory when input path is a directory."
+                )
 
         if os.path.isfile(inpath):
             sassargs.update({"filename": inpath})
@@ -115,7 +118,7 @@ def handle(self, *args, **options):
             if options["g"]:
                 sassargs.update({"source_map_filename": outfile + ".map"})
 
-         # Watch files for changes if specified.
+        # Watch files for changes if specified.
         if options["watch"]:
             try:
                 self.stdout.write("Watching...")
@@ -134,7 +137,7 @@ def handle(self, *args, **options):
                                     needs_updated = True
                                     watchfiles.update({fullpath: curr_mtime})
 
-                    # Recompile the sass if needed
+                    # Recompile the sass if needed.
                     if needs_updated:
                         # Catch compile errors to keep the watcher running.
                         try:
@@ -143,14 +146,14 @@ def handle(self, *args, **options):
                         except sass.CompileError as exc:
                             self.stdout.write(str(exc))
 
-                    # Go back to sleep
+                    # Go back to sleep.
                     time.sleep(3)
 
             except KeyboardInterrupt:
                 self.stdout.write("Bye.")
                 sys.exit(0)
 
-        # Write css
+        # Write css.
         self.stdout.write("Writing css...")
         self.compile_sass(outfile, **sassargs)
         self.stdout.write("Done.")

requirements-dev.txt

@@ -0,0 +1,8 @@
+flake8
+mypy
+pytest
+pytest-cov
+pytest-django
+sphinx
+twine
+wheel

setup.cfg

@@ -0,0 +1,15 @@
+[flake8]
+max-line-length = 100
+exclude = migrations
+
+[mypy]
+ignore_missing_imports = True
+
+[tool:pytest]
+DJANGO_SETTINGS_MODULE = testproject.settings
+junit_family = xunit2
+addopts = --cov django_sass --cov-report html --cov-report xml --junitxml junit/test-results.xml
+python_files = tests.py test_*.py
+filterwarnings =
+    ignore
+    default:::django_sass.*

setup.py

@@ -1,7 +1,9 @@
 import os
 from setuptools import setup, find_packages
+
 from django_sass import __version__
 
+
 with open(os.path.join(os.path.dirname(__file__), "README.md"), encoding="utf8") as readme:
     README = readme.read()
 
@@ -11,7 +13,8 @@
     author="CodeRed LLC",
     author_email="[email protected]",
     url="https://github.com/coderedcorp/django-sass",
-    description="The absolute simplest way to use Sass with Django. Pure Python, minimal dependencies, and no special configuration required!",
+    description=("The absolute simplest way to use Sass with Django. Pure Python, "
+                 "minimal dependencies, and no special configuration required!"),
     long_description=README,
     long_description_content_type="text/markdown",
     license="BSD license",
@@ -21,13 +24,6 @@
         "django",
         "libsass"
     ],
-    extras_require={
-        "dev": [
-            "pylint",
-            "twine",
-            "wheel"
-        ]
-    },
     classifiers=[
         "Intended Audience :: Developers",
         "License :: OSI Approved :: BSD License",

testproject/testproject/settings.py

@@ -85,25 +85,6 @@
 }
 
 
-# Password validation
-# https://docs.djangoproject.com/en/2.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/2.2/topics/i18n/