Initial commit

.editorconfig

@@ -0,0 +1,17 @@
+root = true
+
+[*]
+indent_style = space
+indent_size = 4
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.{scss,sass}]
+indent_size = 2
+
+[*.{yml,yaml}]
+indent_size = 2
+
+[Makefile]
+indent_style = tab

.github/workflows/ci.yml

@@ -0,0 +1,53 @@
+name: Run CI
+
+# Run this workflow every time a new commit pushed to your repository
+on:
+  push:
+    branches:
+      - main
+    tags:
+      - '*'
+  pull_request:
+  workflow_dispatch:
+
+jobs:
+  tests:
+    runs-on: ubuntu-latest
+
+    name: Test the creation of a Django project from the template
+
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: '3.10'
+
+      - name: Install Django 4.2
+        run: pip install django~=4.2.0
+
+      - name: Run the startproject command
+        run: |
+          mkdir tmp
+          django-admin startproject \
+            --template . \
+            --extension=py-tpl,rst,gitignore,in,ini,cfg,toml,yml,yaml \
+            --name LICENSE \
+            -x tmp \
+            -x .github \
+            defaultapp tmp/
+
+      - name: Run basic checks (following README instructions)
+        run: |
+          pip install -e .[tests]
+          django-admin check
+          pytest
+        env:
+          PYTHONPATH: .
+          DJANGO_SETTINGS_MODULE: testapp.settings
+        working-directory: tmp
+
+      - name: Run dummy package build
+        run: |
+          pip install build
+          python -m build
+        working-directory: tmp

.gitignore

@@ -0,0 +1,104 @@
+# 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/
+*.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/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# 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/

.readthedocs.yaml

@@ -0,0 +1,20 @@
+# .readthedocs.yaml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+version: 2
+
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.10"
+
+sphinx:
+  configuration: docs/conf.py
+
+python:
+  install:
+    - method: pip
+      path: .
+      extra_requirements:
+        - docs

LICENSE

@@ -0,0 +1,7 @@
+Copyright {% now "Y" %} Maykin Media
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

MANIFEST.in

@@ -0,0 +1,8 @@
+include *.rst
+include LICENSE
+include {{ project_name }}/py.typed
+recursive-include {{ project_name }} *.html
+recursive-include {{ project_name }} *.txt
+recursive-include {{ project_name }} *.po
+global-exclude __pycache__
+global-exclude *.py[co]

README.rst

@@ -0,0 +1,135 @@
+{% comment %}
+===============
+Getting started
+===============
+
+Below you'll find the steps to create a 3rd-party Django app from scratch,
+using the Maykin Media starting template. The ``<project_root>`` is typically
+placed in your home directory.
+
+.. code-block:: bash
+
+    mkdir <project_root>
+    cd <project_root>
+
+Create the virtual environment that holds your copy of Python and relevant
+libraries:
+
+.. code-block:: bash
+
+    virtualenv env or virtualenv --python=/usr/bin/python3.10 env
+    source env/bin/activate
+    pip install django~=4.2.0
+
+Start a new Django project, named ``<project_name>``, using the template. This
+will be your Python import path.
+
+.. code-block:: bash
+
+    django-admin startproject \
+        --template=https://github.com/maykinmedia/default-app/archive/main.zip \
+        --extension=py-tpl,rst,gitignore,in,ini,cfg,toml,yml,yaml \
+        -x .github \
+        --name LICENSE \
+        <project_name> .
+
+And then set up the Github actions workflows:
+
+.. code-block:: bash
+
+    mv dotgithub .github
+
+{% endcomment %}
+
+Welcome to {{ project_name }}'s documentation!
+=================================================
+
+:Version: 0.1.0
+:Source: https://github.com/maykinmedia/{{ project_name }}
+:Keywords: ``<keywords>``
+:PythonVersion: 3.10
+
+|build-status| |code-quality| |black| |coverage| |docs|
+
+|python-versions| |django-versions| |pypi-version|
+
+<One liner describing the project>
+
+.. contents::
+
+.. section-numbering::
+
+Features
+========
+
+* ...
+* ...
+
+Installation
+============
+
+Requirements
+------------
+
+* Python 3.10 or above
+* Django 4.2 or newer
+
+
+Install
+-------
+
+.. code-block:: bash
+
+    pip install {{ project_name }}
+
+
+Usage
+=====
+
+<document or refer to docs>
+
+Local development
+=================
+
+To install and develop the library locally, use::
+
+.. code-block:: bash
+
+    pip install -e .[tests,coverage,docs,release]
+
+When running management commands via ``django-admin``, make sure to add the root
+directory to the python path (or use ``python -m django <command>``):
+
+.. code-block:: bash
+
+    export PYTHONPATH=. DJANGO_SETTINGS_MODULE=testapp.settings
+    django-admin check
+    # or other commands like:
+    # django-admin makemessages -l nl
+
+
+.. |build-status| image:: https://github.com/maykinmedia/{{ project_name }}/workflows/Run%20CI/badge.svg
+    :alt: Build status
+    :target: https://github.com/maykinmedia/{{ project_name }}/actions?query=workflow%3A%22Run+CI%22
+
+.. |code-quality| image:: https://github.com/maykinmedia/{{ project_name }}/workflows/Code%20quality%20checks/badge.svg
+     :alt: Code quality checks
+     :target: https://github.com/maykinmedia/{{ project_name }}/actions?query=workflow%3A%22Code+quality+checks%22
+
+.. |black| image:: https://img.shields.io/badge/code%20style-black-000000.svg
+    :target: https://github.com/psf/black
+
+.. |coverage| image:: https://codecov.io/gh/maykinmedia/{{ project_name }}/branch/main/graph/badge.svg
+    :target: https://codecov.io/gh/maykinmedia/{{ project_name }}
+    :alt: Coverage status
+
+.. |docs| image:: https://readthedocs.org/projects/{{ project_name }}/badge/?version=latest
+    :target: https://{{ project_name }}.readthedocs.io/en/latest/?badge=latest
+    :alt: Documentation Status
+
+.. |python-versions| image:: https://img.shields.io/pypi/pyversions/{{ project_name }}.svg
+
+.. |django-versions| image:: https://img.shields.io/pypi/djversions/{{ project_name }}.svg
+
+.. |pypi-version| image:: https://img.shields.io/pypi/v/{{ project_name }}.svg
+    :target: https://pypi.org/project/{{ project_name }}/

docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/check_sphinx.py-tpl

@@ -0,0 +1,17 @@
+import subprocess
+
+
+def test_linkcheck(tmpdir):
+    doctrees = tmpdir.join("doctrees")
+    htmldir = tmpdir.join("html")
+    subprocess.check_call(
+        ["sphinx-build", "-W", "-blinkcheck", "-d", str(doctrees), ".", str(htmldir)],
+    )
+
+
+def test_build_docs(tmpdir):
+    doctrees = tmpdir.join("doctrees")
+    htmldir = tmpdir.join("html")
+    subprocess.check_call(
+        ["sphinx-build", "-W", "-bhtml", "-d", str(doctrees), ".", str(htmldir)],
+    )