Skip to content

Commit bad3f94

Browse files
docs: Update documentation + changelog
1 parent 447d340 commit bad3f94

File tree

23 files changed

+3801
-1182
lines changed

23 files changed

+3801
-1182
lines changed

.readthedocs.yaml

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# .readthedocs.yaml
2+
# Read the Docs configuration file
3+
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
4+
5+
version: 2
6+
7+
# Set the OS, Python version, and dependencies
8+
build:
9+
os: ubuntu-22.04
10+
tools:
11+
python: "3.11"
12+
13+
# Build documentation with Sphinx
14+
sphinx:
15+
builder: html
16+
configuration: docs/conf.py
17+
fail_on_warning: false
18+
19+
# Python configuration
20+
python:
21+
install:
22+
- requirements: docs/requirements.txt
23+
- method: pip
24+
path: .
25+
26+
# Additional formats (optional - remove if you don't want PDF/EPUB)
27+
formats:
28+
- pdf
29+
- epub

CHANGELOG.md

Lines changed: 0 additions & 80 deletions
This file was deleted.

CHANGELOG.rst

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
Changelog
2+
=========
3+
4+
All notable changes to this project will be documented in this file.
5+
6+
The format is based on `Keep a Changelog <https://keepachangelog.com/en/1.0.0/>`_,
7+
and this project adheres to `Semantic Versioning <https://semver.org/spec/v2.0.0.html>`_.
8+
9+
0.1.0b1 - 2025-01-XX
10+
--------------------
11+
12+
⚠️ **Beta Release** - Feature complete, ready for testing. API may still change before 1.0.
13+
14+
**Added**
15+
16+
* Multiple user groups support via ``MASKED_GROUPS`` configuration
17+
* Environment variable configuration following 12-factor principles
18+
* Comprehensive documentation with examples and deployment guides
19+
20+
**Changed**
21+
22+
* Improved documentation structure and clarity
23+
* Refined compliance messaging - positions as compliance support tool
24+
25+
**Removed**
26+
27+
* ``database_role()`` context manager - unsafe arbitrary role switching
28+
* ``@database_role_required()`` decorator - potential security risk
29+
* Direct role manipulation utilities - use ``anonymized_data()`` instead
30+
31+
0.1.0-alpha.1 - 2025-09-20
32+
--------------------------
33+
34+
⚠️ **Alpha Release** - Initial preview release.
35+
36+
**Core Features**
37+
38+
* Django models: ``MaskingRule``, ``MaskingPreset``, ``MaskedRole``, ``MaskingLog``
39+
* Management commands: ``anon_init``, ``anon_apply``, ``anon_status``, ``anon_dump``, ``anon_validate``, ``anon_load_yaml``, ``anon_drop``, ``anon_fix_permissions``
40+
* Middleware (``AnonRoleMiddleware``) for automatic role switching based on user groups
41+
* Context managers (``anonymized_data``) for manual control
42+
* Decorators (``@use_anonymized_data``) for view-level anonymization
43+
* Class-based view mixins (``AnonymizedDataMixin``)
44+
* Django admin integration with bulk actions
45+
46+
**Pre-built Presets**
47+
48+
* Django Auth, E-commerce, Healthcare, Finance, Social Media, Education
49+
50+
**Security**
51+
52+
* SQL injection prevention with function validation
53+
* Role-based access control
54+
* Audit logging
55+
* Parameterized queries
56+
57+
**Requirements**
58+
59+
* Python 3.8+
60+
* Django 3.2+
61+
* PostgreSQL 12+ with Anonymizer extension

0 commit comments

Comments
 (0)