Django Document Catalogue

Simple, light-weight, stand-alone, hierarchical document library as a reusable django app.

Use Case:

• you need a library of static media documents (PDF or other formats);
• documents are organized in hierarchical categories;

Features:

• permanent URLs for direct access to document, category, and file download (even if filename changes)
• opt-out private file storage (file storage / downloads protected by login, on by default)
• plugin permissions settings
• plugin document list view customization
• upload / edit / delete documents via django admin, and/or..,
• opt-in user-facing edit / upload / delete views and AJAX API

Dependencies:

• python 3.8+
• django 3.2+
• django-mptt

Configurable file handling:

• django-private-storage

or

• django-constrainedfilefield
• python-magic (if you want to validate file content_types)

Opt-in:

• dropzone: drag-and-drop file uploads
• django-admin-sortable2: drag-and-drop document ordering

Get Me Some of That

• Source Code
• Read The Docs
• Issues
• PyPI

MIT License

Acknowledgments

Special thanks to BC Hydro, Chartwell, and all Contributors

Technology Colophon

Python3, HTML5, CSS3, JavaScript
Django, django-mptt, django-private-storage
jQuery, bootstrap, dropzone

For Developers

• > pip install -r reqirements_dev.txt

Tests

• > pytest
• > tox

Code Style

• > isort
• > black
• > flake8

Versioning

• Semantic Versioning
• > bumpver

Docs

• Sphinx + MyST parser
• Read The Docs

Build / Deploy Automation

• invoke
  • > invoke -l
• GitHub Actions (see .github/workflows)
• GitHub Webhooks (see settings/hooks)