django-markdown-widget 1.0.0__tar.gz

django_markdown_widget-1.0.0/.claude/settings.local.json

@@ -0,0 +1,14 @@
+{
+  "permissions": {
+    "allow": [
+      "Bash(uv run:*)",
+      "Bash(git commit:*)",
+      "Bash(git:*)",
+      "Bash(python -m pytest tests/test_views.py -v)",
+      "Bash(python -m pytest --tb=short)",
+      "Bash(node:*)",
+      "Bash(uv build:*)",
+      "Bash(pip show:*)"
+    ]
+  }
+}

django_markdown_widget-1.0.0/.github/workflows/ci-cd.yml

@@ -0,0 +1,70 @@
+name: CI/CD
+
+on:
+  push:
+    branches: [main]
+    tags:
+      - "v*"
+  pull_request:
+    branches: [main]
+
+jobs:
+  test:
+    name: Test
+    runs-on: ubuntu-latest
+
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.11", "3.12", "3.13"]
+        django-version: ["5.2"]
+        include:
+          - python-version: "3.12"
+            django-version: "6.0"
+          - python-version: "3.13"
+            django-version: "6.0"
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: astral-sh/setup-uv@v5
+        with:
+          enable-cache: true
+
+      - name: Setup Python
+        env:
+          PYTHON_VERSION: "${{ matrix.python-version }}"
+        run: uv python install "$PYTHON_VERSION"
+
+      - name: Install dependencies
+        env:
+          DJANGO_VERSION: "${{ matrix.django-version }}"
+        run: |
+          uv sync --group dev
+          uv pip install "Django~=${DJANGO_VERSION}.0"
+
+      - name: Lint
+        run: uv run ruff check .
+
+      - name: Test
+        run: uv run pytest --cov
+
+  publish:
+    name: Publish to PyPI
+    needs: test
+    runs-on: ubuntu-latest
+    if: startsWith(github.ref, 'refs/tags/v')
+    environment: pypi
+    permissions:
+      id-token: write
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: astral-sh/setup-uv@v5
+
+      - name: Build
+        run: uv build
+
+      - name: Publish
+        run: uv publish --trusted-publishing always

django_markdown_widget-1.0.0/.github/workflows/docs.yml

@@ -0,0 +1,48 @@
+name: Deploy Docs
+
+on:
+  push:
+    branches: [main]
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: pages
+  cancel-in-progress: true
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: astral-sh/setup-uv@v5
+        with:
+          enable-cache: true
+
+      - name: Setup Python
+        run: uv python install 3.13
+
+      - name: Install docs dependencies
+        run: uv sync --group docs
+
+      - name: Build docs
+        run: uv run mkdocs build --strict
+
+      - uses: actions/upload-pages-artifact@v3
+        with:
+          path: site/
+
+  deploy:
+    needs: build
+    runs-on: ubuntu-latest
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+      - id: deployment
+        uses: actions/deploy-pages@v4

django_markdown_widget-1.0.0/.gitignore

@@ -0,0 +1,143 @@
+# 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
+db.sqlite3-journal
+media/
+
+# 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/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# IDE
+.idea/
+.vscode/
+*.swp
+*.swo
+
+# uv specific
+.uv/
+__pypackages__/
+
+# Poetry specific
+poetry.lock
+
+# macOS
+.DS_Store
+
+# Windows
+Thumbs.db
+ehthumbs.db
+Desktop.ini
+
+# Coverage.py
+.coverage.*
+coverage.xml
+htmlcov/
+
+# Superpowers brainstorm sessions
+.superpowers/

django_markdown_widget-1.0.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Jakhongir Ganiev
+
+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.

django_markdown_widget-1.0.0/Makefile

@@ -0,0 +1,41 @@
+.PHONY: help venv install lint format test coverage dist publish release example clean
+
+help: ## Show available commands
+	@grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | awk 'BEGIN {FS = ":.*?## "}; {printf "  %-12s %s\n", $$1, $$2}'
+
+venv: ## Create virtual environment
+	uv venv
+
+install: ## Install with dev dependencies
+	uv sync --group dev
+
+lint: ## Check code style
+	uv run ruff check .
+	uv run ruff format --check .
+
+format: ## Format code
+	uv run ruff check --fix .
+	uv run ruff format .
+
+test: ## Run tests
+	uv run pytest
+
+coverage: ## Run tests with coverage
+	uv run pytest --cov
+
+dist: clean ## Build package
+	uv build
+
+publish: dist ## Publish to PyPI
+	uv publish
+
+example: ## Create example Django project
+	@./scripts/create_example_project.sh
+
+release: lint test ## Release a version (usage: make release v=0.2.0)
+	@./scripts/release.sh $(v)
+
+clean: ## Remove build artifacts
+	rm -rf build/ dist/ *.egg-info
+	find . -type d -name __pycache__ -exec rm -rf {} +
+	find . -type f -name '*.py[co]' -delete

django_markdown_widget-1.0.0/PKG-INFO

@@ -0,0 +1,244 @@
+Metadata-Version: 2.4
+Name: django-markdown-widget
+Version: 1.0.0
+Summary: A GitHub-style markdown editor widget for Django forms
+Author-email: Jakhongir Ganiev <contact@jakhongir.dev>
+License: MIT
+License-File: LICENSE
+Keywords: django,editor,github,markdown,widget
+Classifier: Development Status :: 3 - Alpha
+Classifier: Framework :: Django
+Classifier: Framework :: Django :: 5.2
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Python: >=3.11
+Requires-Dist: django>=5.2
+Requires-Dist: mkdocs-material>=9.7.6
+Requires-Dist: mkdocs>=1.6.1
+Description-Content-Type: text/markdown
+
+# django-md-editor
+
+A GitHub-style markdown editor widget for Django forms and admin.
+
+[![PyPI version](https://img.shields.io/pypi/v/django-markdown-widget.svg)](https://pypi.org/project/django-markdown-widget/)
+[![Python versions](https://img.shields.io/pypi/pyversions/django-markdown-widget.svg)](https://pypi.org/project/django-markdown-widget/)
+[![Django versions](https://img.shields.io/badge/django-5.2%2B-blue.svg)](https://www.djangoproject.com/)
+[![License: MIT](https://img.shields.io/badge/license-MIT-green.svg)](LICENSE)
+[![Docs](https://img.shields.io/badge/docs-mkdocs-blue.svg)](https://ganiyevuz.github.io/django-md-editor/)
+
+**[Documentation](https://ganiyevuz.github.io/django-md-editor/)** | **[PyPI](https://pypi.org/project/django-markdown-widget/)** | **[GitHub](https://github.com/ganiyevuz/django-md-editor)**
+
+## Features
+
+- GitHub-flavored markdown editor with live preview
+- Toolbar with common formatting actions (headings, bold, italic, code, tables, etc.)
+- Image and file uploads with drag & drop support
+- Light, dark, and auto theme support
+- Django admin integration via one-line mixin
+- Template tag and filter for rendering markdown in templates
+- Pluggable renderer and upload handler architecture
+- Automatic media cleanup for orphaned uploads
+- Management command for bulk orphan detection
+- Zero hard dependencies beyond Django (markdown library is optional)
+- Keyboard shortcuts (Ctrl+B, Ctrl+I, Ctrl+K, etc.)
+
+## Installation
+
+```bash
+pip install django-markdown-widget
+```
+
+Add to your `INSTALLED_APPS` and include the URLs:
+
+```python
+# settings.py
+INSTALLED_APPS = [
+    ...
+    "django_md_editor",
+]
+
+# urls.py
+from django.urls import include, path
+
+urlpatterns = [
+    ...
+    path("md-editor/", include("django_md_editor.urls")),
+]
+```
+
+For server-side rendering, install a markdown library:
+
+```bash
+pip install markdown
+```
+
+## Quick Start
+
+### Form Widget
+
+```python
+from django.forms import ModelForm
+from django_md_editor import MarkdownEditorWidget
+
+class PostForm(ModelForm):
+    class Meta:
+        model = Post
+        fields = ["title", "content"]
+        widgets = {
+            "content": MarkdownEditorWidget(),
+        }
+```
+
+### Django Admin
+
+```python
+from django.contrib import admin
+from django_md_editor import MarkdownEditorAdminMixin
+
+@admin.register(Post)
+class PostAdmin(MarkdownEditorAdminMixin, admin.ModelAdmin):
+    list_display = ["title", "created_at"]
+    markdown_fields = ["content"]  # omit to apply to all TextFields
+```
+
+### Template Rendering
+
+```django
+{% load md_editor %}
+
+{# As a filter (recommended) #}
+{{ post.content|markdown }}
+
+{# As a tag #}
+{% markdown post.content %}
+```
+
+### Media Cleanup
+
+```python
+from django_md_editor import MarkdownCleanupMixin
+
+class Post(MarkdownCleanupMixin, models.Model):
+    content = models.TextField()
+    # markdown_cleanup_fields = ["content"]  # optional: limit to specific fields
+```
+
+Enable in settings:
+
+```python
+MD_EDITOR = {
+    "CLEANUP_MEDIA": True,
+}
+```
+
+Bulk cleanup via management command:
+
+```bash
+python manage.py cleanup_markdown_media --dry-run
+python manage.py cleanup_markdown_media
+```
+
+## Configuration
+
+All settings are optional and go under `MD_EDITOR` in your Django settings:
+
+```python
+MD_EDITOR = {
+    # Pluggable backend classes
+    "RENDERER_CLASS": "django_md_editor.renderers.DefaultRenderer",
+    "UPLOAD_HANDLER_CLASS": "django_md_editor.uploads.DefaultUploadHandler",
+
+    # Toolbar buttons
+    "TOOLBAR": [
+        "heading", "bold", "italic", "strikethrough", "separator",
+        "quote", "code", "code-block", "link", "image", "separator",
+        "ordered-list", "unordered-list", "task-list", "separator",
+        "horizontal-rule", "table", "details", "separator",
+        "highlight", "superscript", "subscript", "separator",
+        "attach", "mention", "ref", "separator",
+        "undo", "redo", "fullscreen",
+    ],
+
+    # Upload settings
+    "ALLOWED_UPLOAD_TYPES": ["image/png", "image/jpeg", "image/gif", "image/webp"],
+    "MAX_UPLOAD_SIZE": 10 * 1024 * 1024,  # 10 MB
+    "UPLOAD_PATH": "md-editor/uploads/%Y/%m/",
+
+    # Editor defaults
+    "DEFAULT_HEIGHT": "300px",
+    "PLACEHOLDER": "Add your comment here...",
+    "THEME": "auto",  # "light", "dark", or "auto"
+
+    # Security
+    "REQUIRE_AUTH": True,
+
+    # Media cleanup
+    "CLEANUP_MEDIA": False,
+}
+```
+
+## Custom Renderer
+
+```python
+from django_md_editor import BaseRenderer
+
+class MyRenderer(BaseRenderer):
+    def render(self, markdown_text: str) -> str:
+        import markdown_it
+        md = markdown_it.MarkdownIt()
+        return md.render(markdown_text)
+```
+
+```python
+MD_EDITOR = {
+    "RENDERER_CLASS": "myapp.renderers.MyRenderer",
+}
+```
+
+## Custom Upload Handler
+
+```python
+from django_md_editor import BaseUploadHandler
+
+class S3UploadHandler(BaseUploadHandler):
+    def validate(self, file):
+        # your validation logic
+        pass
+
+    def save(self, file) -> str:
+        # save to S3 and return the URL
+        return url
+```
+
+```python
+MD_EDITOR = {
+    "UPLOAD_HANDLER_CLASS": "myapp.uploads.S3UploadHandler",
+}
+```
+
+## Development
+
+```bash
+git clone https://github.com/ganiyevuz/django-md-editor.git
+cd django-md-editor
+uv sync --group dev
+make test
+make lint
+```
+
+Run the example app:
+
+```bash
+cd example
+python manage.py migrate
+python manage.py createsuperuser
+python manage.py runserver
+```
+
+## License
+
+MIT License. See [LICENSE](LICENSE) for details.