markdown-cms 0.1.0__tar.gz

markdown_cms-0.1.0/.gitignore

@@ -0,0 +1,197 @@
+# 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/
+share/python-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/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# 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/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be added to the global gitignore or merged into this project gitignore.  For a PyCharm
+#  project, it is recommended to include the following files in version control:
+#  - .idea/modules.xml
+#  - .idea/*.iml
+#  - .idea/misc.xml
+#  - .idea/vcs.xml
+.idea/
+
+# VS Code
+.vscode/
+!.vscode/settings.json
+!.vscode/tasks.json
+!.vscode/launch.json
+!.vscode/extensions.json
+!.vscode/*.code-snippets
+
+# Local History for Visual Studio Code
+.history/
+
+# Built Visual Studio Code Extensions
+*.vsix
+
+# Project specific
+site/content/.cache/
+site/database/
+site/uploads/
+logs/
+*.sqlite
+*.sqlite-journal
+*.db
+*.db-journal
+
+# Session key (runtime secret)
+.sesskey
+
+# Claude Code local settings
+.claude/
+
+# Windows artifacts
+nul
+This

markdown_cms-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Rakesh Patil
+
+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.

markdown_cms-0.1.0/PKG-INFO

@@ -0,0 +1,301 @@
+Metadata-Version: 2.4
+Name: markdown-cms
+Version: 0.1.0
+Summary: Markdown-first CMS and Application Framework
+Project-URL: Homepage, https://github.com/rakeshpatil1983/markdown-cms
+Project-URL: Documentation, https://github.com/rakeshpatil1983/markdown-cms/docs
+Project-URL: Repository, https://github.com/rakeshpatil1983/markdown-cms.git
+Project-URL: Issues, https://github.com/rakeshpatil1983/markdown-cms/issues
+Author-email: Rakesh Patil <rakeshpatil1983@gmail.com>
+License: MIT
+License-File: LICENSE
+Keywords: cms,fasthtml,htmx,markdown,web-framework
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Python: >=3.12
+Requires-Dist: markdown-it-py>=3.0.0
+Requires-Dist: passlib[bcrypt]>=1.7.4
+Requires-Dist: python-fasthtml>=0.12.0
+Requires-Dist: python-jose[cryptography]>=3.3.0
+Requires-Dist: python-multipart>=0.0.9
+Requires-Dist: sqlalchemy>=2.0.0
+Provides-Extra: dev
+Requires-Dist: black>=24.0.0; extra == 'dev'
+Requires-Dist: isort>=5.13.0; extra == 'dev'
+Requires-Dist: pre-commit>=3.6.0; extra == 'dev'
+Requires-Dist: pytest-asyncio>=0.23.0; extra == 'dev'
+Requires-Dist: pytest-cov>=4.0.0; extra == 'dev'
+Requires-Dist: pytest>=8.0.0; extra == 'dev'
+Requires-Dist: ruff>=0.1.0; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# Markdown-First Application Framework
+
+A Markdown-first CMS and Application Framework built with FastHTML and HTMX.
+
+> **Philosophy**: Everything is a file. Everything is Markdown. Markdown is declarative UI, Python is behavior.
+
+---
+
+## What Is This?
+
+`markdown-cms` is a Python web framework where you build complete web applications by writing Markdown files — not just documentation sites.
+
+Pages, layouts, navigation, forms, interactive calculators, data tables, component libraries, admin panels — all driven by Markdown and a file-based structure. Python handles behavior; Markdown handles structure and intent.
+
+Think of it as the intersection of **Obsidian's file-first philosophy**, **WordPress's template system**, and **Django's project structure** — but lighter, faster, and Markdown-native.
+
+### Real-World Reference: TechArya
+
+[TechArya.net](https://techarya.net) — an electronics and embedded systems learning platform — was built and migrated using this framework. It demonstrates the framework's capability beyond documentation:
+
+- **25+ structured electronics lessons** with diagrams, formulas, and categorized navigation
+- **Live HTMX calculators** (Ohm's Law, RC filter, power) — form submission returns parsed Markdown responses
+- **Nested subject navigation** with auto-generated sidebar trees from the file structure
+- **Multi-theme switching** (Bootstrap, Bulma, Tailwind, Materialize) at runtime
+- **Image galleries, tables, alerts, carousels** — all from Markdown
+
+TechArya is proof that this framework handles real content-heavy, interactive applications — not just static docs.
+
+---
+
+## What Can You Build With It?
+
+This is **not** a documentation generator. It is a full application framework. You can build:
+
+| Use Case | How |
+|---|---|
+| Documentation sites | pages/ + markdown content |
+| Learning platforms | Nested subject folders + sidebar auto-navigation |
+| Company portals | Template parts (header/footer/nav) + themes |
+| Technical blogs | File-based routing + metadata |
+| Interactive tools | HTMX endpoints + Python API handlers in api.py |
+| Admin dashboards | Built-in admin routes + SQLite database |
+| Product landing pages | Cards, heroes, stats, columns — all in Markdown |
+| Form-driven apps | `:::form` blocks + Python POST handlers |
+
+---
+
+## Philosophy
+
+> Markdown describes structure and intent. Python executes behavior and truth.
+
+This framework enforces a strict separation:
+
+- **Markdown** = pages, layout, content, UI structure, forms, components
+- **Python** = business logic, database queries, API responses, authentication
+
+If a feature requires putting Python logic inside a Markdown file — it does not belong here.
+
+### Pure Text Syntax
+
+The framework extends Markdown with a clean, readable syntax for UI elements:
+
+```
+=> Click Me              ->  <button class="btn btn-primary">
+=> Save (success)        ->  <button class="btn btn-success">
+=> Delete (danger)       ->  <button class="btn btn-danger">
+
+? Your Name (text)       ->  <input type="text">
+?? Your Message          ->  <textarea>
+
+> [!SUCCESS] Saved!      ->  styled success alert
+> [!WARNING] Review      ->  styled warning alert
+
+:::card
+# Title
+Content here
+=> Learn More
+:::
+```
+
+No HTML required. No YAML. No JSON. Just text that reads like what it means.
+
+---
+
+## Quick Start
+
+```bash
+pip install markdown-cms
+
+# Create a new project
+markdown-cms create my-project
+cd my-project
+
+# Run development server
+markdown-cms run
+```
+
+Open `http://localhost:8000` — your site is live with auto-reload.
+
+---
+
+## Features
+
+- **File-based routing** — `pages/about.md` becomes `/about`, `pages/docs/intro.md` becomes `/docs/intro`
+- **Template parts** — WordPress-style `header.md`, `footer.md`, `navbar.md`, `sidenav.md`
+- **Multi-theme system** — Switch between Bootstrap, Bulma, Tailwind, Materialize with one command
+- **HTMX-native** — Components load via HTMX fragments; no page refresh needed
+- **Component library** — 3-level hierarchy: Elements, Containers, Layout
+- **Plugin system** — Drop Python plugins into `plugins/` directory
+- **Admin panel** — Built-in content management at `/admin`
+- **Authentication** — JWT-based auth, user management
+- **Database** — SQLite via SQLAlchemy, with CLI commands (`markdown-cms db init/seed/reset`)
+- **Auto-reload** — Watches `pages/`, `templates/`, `static/` for changes
+- **API routes** — Drop an `api.py` in your project root; the framework auto-loads it
+- **Agents** — Built-in orchestrator, implementation, and testing agents for development assistance
+
+---
+
+## Project Structure
+
+```
+my-project/
+├── pages/           # Markdown content -> URL routes
+├── templates/       # header.md, footer.md, navbar.md, sidenav.md
+├── static/          # CSS, JS, images
+├── components/      # Reusable HTMX-loadable markdown fragments
+│   ├── elements/    # Buttons, inputs, dropdowns
+│   ├── containers/  # Cards, panels, tabs
+│   └── layout/      # Navbar, sidebar, header, footer
+├── themes/          # bootstrap/, bulma/, tailwind/, materialize/
+├── apps/            # Custom Django-style applications
+├── plugins/         # Custom plugins
+└── api.py           # Your HTMX API endpoints (auto-loaded)
+```
+
+---
+
+## CLI Commands
+
+```bash
+markdown-cms create <name>          # Scaffold new project
+markdown-cms run                    # Development server (auto-reload)
+markdown-cms run --port 3000        # Custom port
+markdown-cms build                  # Validate project structure
+markdown-cms theme bootstrap        # Switch to Bootstrap theme
+markdown-cms theme tailwind         # Switch to Tailwind theme
+markdown-cms db init                # Create database tables
+markdown-cms db seed                # Seed with sample data
+markdown-cms db reset               # Drop and recreate (with confirmation)
+markdown-cms db info                # Show database info
+markdown-cms agent orchestrator     # Run development orchestrator agent
+```
+
+---
+
+## Writing HTMX API Routes
+
+Create `api.py` in your project root — the framework loads it automatically:
+
+```python
+from markdown_cms.core.parser import MarkdownParser
+from fasthtml.common import NotStr
+
+_parser = MarkdownParser()
+
+def render_markdown(md_text):
+    return _parser.parse(md_text).get("html", "")
+
+def setup_api_routes(app):
+
+    @app.post("/api/calculate")
+    async def calculate(request):
+        form = await request.form()
+        value = float(form.get("input", 0))
+        result = value * 2
+
+        # Return Markdown — the library parses it to HTML
+        md = f"> [!SUCCESS] Result\n> **{result}**"
+        return NotStr(render_markdown(md))
+```
+
+Then call it from any Markdown page:
+
+```markdown
+:::form /api/calculate
+? Input Value (number)
+=> Calculate (success)
+:::
+```
+
+Zero boilerplate. No templates. Pure Markdown + Python.
+
+---
+
+## Limitations
+
+The framework is at **v0.1.0 / Alpha** stage. Known limitations:
+
+- **No built-in search** — full-text search across pages requires a custom plugin
+- **SQLite only** — no PostgreSQL or MySQL support yet
+- **Single-user auth** — multi-tenant or org-level permissions not implemented
+- **No asset pipeline** — CSS/JS is served as-is; no bundling or minification
+- **Plugin API is minimal** — the plugin scaffold exists but the hook system is early-stage
+- **No live preview in admin** — content edits require a page reload to see final output
+- **Python 3.12+ required** — uses modern type annotation syntax throughout
+- **No i18n/l10n** — no built-in internationalisation support
+
+---
+
+## Roadmap / Feature Improvements
+
+Planned for future versions:
+
+| Feature | Priority |
+|---|---|
+| Full-text search across pages | High |
+| PostgreSQL / MySQL support | High |
+| Live admin preview panel | High |
+| Image upload + media manager | Medium |
+| Tag and category system | Medium |
+| RSS / sitemap generation | Medium |
+| Plugin hook system (before/after render) | Medium |
+| Multi-language content support | Medium |
+| Role-based access control | Medium |
+| Static site export (SSG mode) | Low |
+| CLI scaffolding for custom plugins | Low |
+| VS Code / Obsidian extension | Low |
+
+---
+
+## Tech Stack
+
+| Component | Technology |
+|---|---|
+| Web framework | [FastHTML](https://fastht.ml) |
+| Interactivity | [HTMX](https://htmx.org) |
+| Markdown parsing | [markdown-it-py](https://markdown-it-py.readthedocs.io) |
+| Database ORM | [SQLAlchemy](https://sqlalchemy.org) |
+| Auth | python-jose + passlib |
+| Build | [Hatchling](https://hatch.pypa.io) |
+
+---
+
+## Development
+
+```bash
+git clone https://github.com/rakeshpatil1983/markdown-cms
+cd markdown-cms
+pip install -e ".[dev]"
+pre-commit install
+pytest
+```
+
+---
+
+## License
+
+MIT License — see [LICENSE](LICENSE) for details.
+
+---
+
+## Contributing
+
+Contributions welcome. Please open an issue before submitting large changes.
+
+> Markdown describes structure and intent. Python executes behavior and truth.