feat: initial implementation [BB-7595]

.annotation_safe_list.yml

@@ -8,34 +8,54 @@
 #    ".. choice_annotation:": foo, bar, baz
 
 admin.LogEntry:
-  ".. no_pii:": "This model has no PII"
+  ".. no_pii:": This model has no PII
 auth.Group:
-  ".. no_pii:": "This model has no PII"
+  ".. no_pii:": This model has no PII
 auth.Permission:
-  ".. no_pii:": "This model has no PII"
+  ".. no_pii:": This model has no PII
 auth.User:
-  ".. pii": "This model minimally contains a username, password, and email"
-  ".. pii_types": "username, email_address, password"
-  ".. pii_retirement": "consumer_api"
+  ".. pii": This model minimally contains a username, password, and email
+  ".. pii_types": username, email_address, password
+  ".. pii_retirement": consumer_api
 contenttypes.ContentType:
-  ".. no_pii:": "This model has no PII"
+  ".. no_pii:": This model has no PII
+completion.BlockCompletion:
+  ".. no_pii:": This model has no PII
+completion_aggregator.Aggregator:
+  ".. no_pii:": This model has no PII
+completion_aggregator.CacheGroupInvalidation:
+  ".. no_pii:": This model has no PII
+completion_aggregator.StaleCompletion:
+  ".. pii": This model contains a username; the entries are regularly cleaned up (usually every hour)
+django_celery_beat.ClockedSchedule:
+  ".. no_pii:": This model has no PII
+django_celery_beat.CrontabSchedule:
+  ".. no_pii:": This model has no PII
+django_celery_beat.IntervalSchedule:
+  ".. no_pii:": This model has no PII
+django_celery_beat.PeriodicTask:
+  ".. no_pii:": This model has no PII
+django_celery_beat.PeriodicTasks:
+  ".. no_pii:": This model has no PII
+django_celery_beat.SolarSchedule:
+  ".. no_pii:": This model has no PII
 sessions.Session:
-  ".. no_pii:": "This model has no PII"
+  ".. no_pii:": This model has no PII
 social_django.Association:
-  ".. no_pii:": "This model has no PII"
+  ".. no_pii:": This model has no PII
 social_django.Code:
-  ".. pii:": "Email address"
+  ".. pii:": Email address
   ".. pii_types:": other
   ".. pii_retirement:": local_api
 social_django.Nonce:
-  ".. no_pii:": "This model has no PII"
+  ".. no_pii:": This model has no PII
 social_django.Partial:
-  ".. no_pii:": "This model has no PII"
+  ".. no_pii:": This model has no PII
 social_django.UserSocialAuth:
-  ".. no_pii:": "This model has no PII"
+  ".. no_pii:": This model has no PII
 waffle.Flag:
-  ".. no_pii:": "This model has no PII"
+  ".. no_pii:": This model has no PII
 waffle.Sample:
-  ".. no_pii:": "This model has no PII"
+  ".. no_pii:": This model has no PII
 waffle.Switch:
-  ".. no_pii:": "This model has no PII"
+  ".. no_pii:": This model has no PII

.coveragerc

@@ -8,3 +8,5 @@ omit =
     *admin.py
     */static/*
     */templates/*
+    */tests/*
+    */settings/*

.editorconfig

@@ -94,7 +94,4 @@ trim_trailing_whitespace = false
 [COMMIT_EDITMSG]
 max_line_length = 72
 
-[*.rst]
-max_line_length = 79
-
 # f2f02689fced7a2e0c62c2f9803184114dc2ae4b

.github/workflows/ci.yml

@@ -5,7 +5,7 @@ on:
     branches: [main]
   pull_request:
     branches:
-    - '**'
+      - '**'
 
 
 jobs:
@@ -19,27 +19,31 @@ jobs:
         toxenv: [quality, docs, pii_check, django32, django40, package]
 
     steps:
-    - uses: actions/checkout@v3
-    - name: setup python
-      uses: actions/setup-python@v4
-      with:
-        python-version: ${{ matrix.python-version }}
-
-    - name: Install pip
-      run: pip install -r requirements/pip.txt
-
-    - name: Install Dependencies
-      run: pip install -r requirements/ci.txt
-
-    - name: Run Tests
-      env:
-        TOXENV: ${{ matrix.toxenv }}
-      run: tox
-
-    - name: Run coverage
-      if: matrix.python-version == '3.8' && matrix.toxenv == 'django32'
-      uses: codecov/codecov-action@v3
-      with:
-        token: ${{ secrets.CODECOV_TOKEN }}
-        flags: unittests
-        fail_ci_if_error: true
+      - uses: actions/checkout@v3
+      - name: setup python
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: setup graphviz
+        if: matrix.toxenv == 'docs'
+        uses: ts-graphviz/setup-graphviz@v1
+
+      - name: Install pip
+        run: pip install -r requirements/pip.txt
+
+      - name: Install Dependencies
+        run: pip install -r requirements/ci.txt
+
+      - name: Run Tests
+        env:
+          TOXENV: ${{ matrix.toxenv }}
+        run: tox
+
+      - name: Run coverage
+        if: matrix.python-version == '3.8' && matrix.toxenv == 'django32'
+        uses: codecov/codecov-action@v3
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+          flags: unittests
+          fail_ci_if_error: true

.github/workflows/lint.yml

@@ -5,7 +5,7 @@ on:
     branches: [main]
   pull_request:
     branches:
-    - '**'
+      - '**'
 
 jobs:
   lint:

.github/workflows/upgrade-python-requirements.yml

@@ -2,7 +2,7 @@ name: Upgrade Python Requirements
 
 on:
   schedule:
-    - cron: "0 2 * * 1"
+    - cron: 0 2 * * 1
   workflow_dispatch:
     inputs:
       branch:

.gitignore

@@ -33,6 +33,7 @@ pip-log.txt
 coverage.xml
 htmlcov/
 pii_report/
+default.db
 
 
 

.pii_annotations.yml

@@ -7,29 +7,29 @@ annotations:
     "pii_group":
         - ".. pii:":
         - ".. pii_types:":
-            choices:
-              - id # Unique identifier for the user which is shared across systems
-              - name # Used for any part of the user's name
-              - username
-              - password
-              - location # Used for any part of any type address or country stored
-              - phone_number # Used for phone or fax numbers
-              - email_address
-              - birth_date # Used for any part of a stored birth date
-              - ip # IP address
-              - external_service # Used for external service ids or links such as social media links or usernames, website links, etc.
-              - biography # Any type of free-form biography field
-              - gender
-              - sex
-              - image
-              - video
-              - other
+              choices:
+                  - id  # Unique identifier for the user which is shared across systems
+                  - name  # Used for any part of the user's name
+                  - username
+                  - password
+                  - location  # Used for any part of any type address or country stored
+                  - phone_number  # Used for phone or fax numbers
+                  - email_address
+                  - birth_date  # Used for any part of a stored birth date
+                  - ip  # IP address
+                  - external_service  # Used for external service ids or links such as social media links or usernames, website links, etc.
+                  - biography  # Any type of free-form biography field
+                  - gender
+                  - sex
+                  - image
+                  - video
+                  - other
         - ".. pii_retirement:":
-            choices:
-              - retained     # Intentionally kept for legal reasons
-              - local_api    # An API exists in this repository for retiring this information
-              - consumer_api # The data's consumer must implement an API for retiring this information
-              - third_party  # A third party API exists to retire this data
+              choices:
+                  - retained      # Intentionally kept for legal reasons
+                  - local_api     # An API exists in this repository for retiring this information
+                  - consumer_api  # The data's consumer must implement an API for retiring this information
+                  - third_party   # A third party API exists to retire this data
 extensions:
     python:
         - py

.readthedocs.yml

@@ -9,7 +9,17 @@ version: 2
 sphinx:
   configuration: docs/conf.py
 
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.8"
+  apt_packages:
+    - graphviz
+
 python:
-  version: 3.8
   install:
     - requirements: requirements/doc.txt
+
+formats:
+  - epub
+  - pdf

.yamllint.yml

@@ -0,0 +1,22 @@
+extends: default
+
+ignore: |
+  .pytest_cache/
+  .ruff_cache/
+  .tox/
+  pii_report/
+  venv/
+rules:
+  indentation:
+    spaces: consistent
+    check-multi-line-strings: true
+  line-length: disable
+  document-start: disable
+  quoted-strings:
+    quote-type: any
+    required: only-when-needed
+  braces:
+    forbid: non-empty
+    level: warning
+  truthy:
+    check-keys: false

CHANGELOG.rst

@@ -16,10 +16,10 @@ Unreleased
 
 *
 
-0.1.0 – 2023-08-17
+0.1.0 – 2023-09-17
 **********************************************
 
 Added
 =====
 
-* First release on PyPI.
+* Initial implementation of the certificates app.

Makefile

@@ -63,19 +63,18 @@ piptools: ## install pinned version of pip-compile and pip-sync
 requirements: piptools ## install development environment requirements
 	pip-sync -q requirements/dev.txt requirements/private.*
 
-lint: ## lint all Python files
+lint: ## lint all files
 	black .
+	yamllint .
 
 test: clean ## run tests in the current virtualenv
 	pytest
 
 diff_cover: test ## find diff lines that need test coverage
 	diff-cover coverage.xml
 
-test-all: quality pii_check ## run tests on every supported Python/Django combination
-	tox
-	tox -e docs
-	tox -e package
+test-all: ## run all tests
+	tox --parallel
 
 validate: quality pii_check test ## run tests and quality checks