clickmd 1.0.0__tar.gz

clickmd-1.0.0/.gitignore

@@ -0,0 +1,180 @@
+test-verify/
+output_p3_verify2/
+output_*/
+output_p3_*/
+output/
+output*/
+my-app/
+my-crm/
+express/
+LegacyApp/
+src-reproduction/
+setup/
+generated*/
+generated2/
+my-app
+refactor-workspace/
+*.egg-info
+test-todo-prompt
+test-lifecycle
+test-lifecycle-*
+test-prompt-*
+.test-output
+test-guide
+test-docs
+test-notes
+test-verify
+.test-output-e2e
+target
+.idea
+venv
+contracts/venv
+pycontracts/venv
+__pycache__/
+*.pyc
+generated/
+reclapp.egg-info/
+pycontracts.egg-info/
+package-lock.json
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+*.lcov
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# Snowpack dependency directory (https://snowpack.dev/)
+web_modules/
+
+# TypeScript cache
+*.tsbuildinfo
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional stylelint cache
+.stylelintcache
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variable files
+.env
+.env.*
+!.env.example
+!.env.examples
+!examples/**/.env.examples
+!studio/.env.example
+
+# parcel-bundler cache (https://parceljs.org/)
+.cache
+.parcel-cache
+
+# Next.js build output
+.next
+out
+
+# Nuxt.js build / generate output
+.nuxt
+dist
+
+# Gatsby files
+.cache/
+# Comment in the public line in if your project uses Gatsby and not Next.js
+# https://nextjs.org/blog/next-9-1#public-directory-support
+# public
+
+# vuepress build output
+.vuepress/dist
+
+# vuepress v2.x temp and cache directory
+.temp
+.cache
+
+# Sveltekit cache directory
+.svelte-kit/
+
+# vitepress build output
+**/.vitepress/dist
+
+# vitepress cache directory
+**/.vitepress/cache
+
+# Docusaurus cache and generated files
+.docusaurus
+
+# Serverless directories
+.serverless/
+
+# FuseBox cache
+.fusebox/
+
+# DynamoDB Local files
+.dynamodb/
+
+# Firebase cache directory
+.firebase/
+
+# TernJS port file
+.tern-port
+
+# Stores VSCode versions used for testing VSCode extensions
+.vscode-test
+
+# yarn v3
+.pnp.*
+.yarn/*
+!.yarn/patches
+!.yarn/plugins
+!.yarn/releases
+!.yarn/sdks
+!.yarn/versions
+
+# Vite logs files
+vite.config.js.timestamp-*
+vite.config.ts.timestamp-*

clickmd-1.0.0/CHANGELOG.md

@@ -0,0 +1,40 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [1.0.0] - 2024-01-07
+
+### Added
+- Initial release
+- `md()` function for markdown rendering
+- `echo()` smart function with auto-detection
+- `MarkdownRenderer` class for advanced usage
+- Syntax highlighting for:
+  - Python (keywords, decorators, strings, comments)
+  - TypeScript/JavaScript (keywords, strings, template literals)
+  - JSON (keys, values, numbers, booleans)
+  - YAML (keys, values, comments, lists)
+  - Bash/Shell (commands, comments)
+  - Markdown (headers, bold, links)
+  - Log (status emojis, errors, warnings)
+- Click decorators re-export (optional dependency)
+- Zero-dependency core functionality
+- Full test suite
+- Examples and documentation
+
+### Features
+- Works without Click installed
+- Auto-detects TTY for color output
+- Supports custom output streams
+- Type hints (py.typed marker)
+
+## [Unreleased]
+
+### Planned
+- Table rendering
+- Progress bars
+- Box/panel rendering
+- More language highlighters

clickmd-1.0.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Reclapp Team
+
+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.

clickmd-1.0.0/Makefile

@@ -0,0 +1,89 @@
+.PHONY: help install dev test lint format type-check clean build publish publish-test docs
+
+PYTHON := python3
+PIP := pip
+PYTEST := pytest
+RUFF := ruff
+BLACK := black
+MYPY := mypy
+
+help:
+	@echo "clickmd - Markdown rendering for CLI applications"
+	@echo ""
+	@echo "Usage: make <target>"
+	@echo ""
+	@echo "Development:"
+	@echo "  install      Install package in development mode"
+	@echo "  dev          Install with all development dependencies"
+	@echo "  test         Run tests with pytest"
+	@echo "  test-cov     Run tests with coverage report"
+	@echo "  lint         Run ruff linter"
+	@echo "  format       Format code with black and ruff"
+	@echo "  type-check   Run mypy type checker"
+	@echo "  check        Run all checks (lint, type-check, test)"
+	@echo ""
+	@echo "Build & Publish:"
+	@echo "  clean        Remove build artifacts"
+	@echo "  build        Build package (sdist and wheel)"
+	@echo "  publish-test Publish to TestPyPI"
+	@echo "  publish      Publish to PyPI"
+	@echo ""
+	@echo "Documentation:"
+	@echo "  docs         Generate documentation"
+
+install:
+	$(PIP) install -e .
+
+dev:
+	$(PIP) install -e ".[dev,click]"
+
+test:
+	$(PYTEST) tests/ -v
+
+test-cov:
+	$(PYTEST) tests/ -v --cov=. --cov-report=term-missing --cov-report=html
+
+lint:
+	$(RUFF) check .
+	$(RUFF) format --check .
+
+format:
+	$(RUFF) format .
+	$(RUFF) check --fix .
+
+type-check:
+	$(MYPY) --ignore-missing-imports .
+
+check: lint type-check test
+
+clean:
+	rm -rf build/
+	rm -rf dist/
+	rm -rf *.egg-info/
+	rm -rf .pytest_cache/
+	rm -rf .mypy_cache/
+	rm -rf .ruff_cache/
+	rm -rf htmlcov/
+	rm -rf .coverage
+	find . -type d -name __pycache__ -exec rm -rf {} + 2>/dev/null || true
+	find . -type f -name "*.pyc" -delete
+
+build: clean
+	$(PYTHON) -m build
+
+publish-test: build
+	$(PYTHON) -m twine upload --repository testpypi dist/*
+
+publish: build
+	$(PYTHON) -m twine upload dist/*
+
+docs:
+	@echo "Documentation is in README.md and docs/"
+	@echo "For API docs, consider using pdoc or sphinx"
+
+# Development shortcuts
+.PHONY: t l f c
+t: test
+l: lint
+f: format
+c: check

clickmd-1.0.0/PKG-INFO

@@ -0,0 +1,262 @@
+Metadata-Version: 2.4
+Name: clickmd
+Version: 1.0.0
+Summary: Markdown rendering for CLI applications with syntax highlighting
+Project-URL: Homepage, https://github.com/wronai/clickmd
+Project-URL: Documentation, https://github.com/wronai/clickmd#readme
+Project-URL: Repository, https://github.com/wronai/clickmd
+Project-URL: Issues, https://github.com/wronai/clickmd/issues
+Author-email: Reclapp Team <contact@reclapp.io>
+License-Expression: MIT
+License-File: LICENSE
+Keywords: ansi,cli,colors,markdown,syntax-highlighting,terminal
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Terminals
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Provides-Extra: all
+Requires-Dist: black>=23.0; extra == 'all'
+Requires-Dist: click>=8.0; extra == 'all'
+Requires-Dist: mypy>=1.0; extra == 'all'
+Requires-Dist: pytest-cov>=4.0; extra == 'all'
+Requires-Dist: pytest>=7.0; extra == 'all'
+Requires-Dist: ruff>=0.1.0; extra == 'all'
+Provides-Extra: click
+Requires-Dist: click>=8.0; extra == 'click'
+Provides-Extra: dev
+Requires-Dist: black>=23.0; extra == 'dev'
+Requires-Dist: mypy>=1.0; extra == 'dev'
+Requires-Dist: pytest-cov>=4.0; extra == 'dev'
+Requires-Dist: pytest>=7.0; extra == 'dev'
+Requires-Dist: ruff>=0.1.0; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# clickmd
+
+[![PyPI version](https://badge.fury.io/py/clickmd.svg)](https://badge.fury.io/py/clickmd)
+[![Python 3.10+](https://img.shields.io/badge/python-3.10+-blue.svg)](https://www.python.org/downloads/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![Tests](https://github.com/wronai/clickmd/actions/workflows/tests.yml/badge.svg)](https://github.com/wronai/clickmd/actions)
+[![codecov](https://codecov.io/gh/wronai/clickmd/branch/main/graph/badge.svg)](https://codecov.io/gh/wronai/clickmd)
+
+**Markdown rendering for CLI applications with syntax highlighting.**
+
+`clickmd` provides beautiful terminal output with:
+- 🎨 **Syntax highlighting** for code blocks (Python, TypeScript, JSON, YAML, Bash, etc.)
+- 📝 **Markdown rendering** with headers, bold, links, and more
+- 🔧 **Zero dependencies** for core functionality
+- 🖱️ **Optional Click integration** for CLI decorators
+
+## Installation
+
+```bash
+# Core package (no dependencies)
+pip install clickmd
+
+# With Click support
+pip install clickmd[click]
+```
+
+## Quick Start
+
+### Basic Usage (No Dependencies)
+
+```python
+from clickmd import md, echo
+
+# Render markdown with syntax highlighting
+md("""
+# Hello World
+
+This is **bold** and this is a [link](https://example.com).
+
+```python
+def greet(name: str) -> str:
+    return f"Hello, {name}!"
+```
+""")
+
+# Smart echo - auto-detects markdown
+echo("## Status Update")
+echo("Regular text without markdown")
+```
+
+### With Click Integration
+
+```python
+import clickmd as click
+
+@click.group()
+def cli():
+    """My awesome CLI tool"""
+    pass
+
+@cli.command()
+@click.option("--name", "-n", default="World")
+def hello(name: str):
+    """Say hello"""
+    click.md(f"""
+## 👋 Hello, {name}!
+
+Welcome to **clickmd** - making CLIs beautiful.
+    """)
+
+if __name__ == "__main__":
+    cli()
+```
+
+## Features
+
+### Syntax Highlighting
+
+`clickmd` provides syntax highlighting for multiple languages:
+
+| Language | Extensions | Highlight Features |
+|----------|------------|-------------------|
+| Python | `.py` | Keywords, strings, comments, decorators |
+| TypeScript/JavaScript | `.ts`, `.js` | Keywords, strings, template literals |
+| JSON | `.json` | Keys, strings, numbers, booleans |
+| YAML | `.yaml`, `.yml` | Keys, values, comments |
+| Bash/Shell | `.sh`, `.bash` | Commands, comments |
+| Markdown | `.md` | Headers, bold, links |
+| Log | `.log` | Errors (red), warnings (yellow), success (green) |
+
+### Markdown Elements
+
+```python
+from clickmd import md
+
+md("""
+# Heading 1
+## Heading 2
+### Heading 3
+
+**Bold text** and regular text.
+
+[Links](https://example.com) are supported.
+
+```python
+# Code blocks with syntax highlighting
+print("Hello, World!")
+```
+
+- List items
+- Are rendered
+- Correctly
+""")
+```
+
+### MarkdownRenderer Class
+
+For more control, use the `MarkdownRenderer` class directly:
+
+```python
+from clickmd import MarkdownRenderer
+import sys
+
+renderer = MarkdownRenderer(use_colors=True, stream=sys.stdout)
+renderer.heading(1, "My Title")
+renderer.codeblock("python", 'print("Hello!")')
+```
+
+### Progress and Status Output
+
+```python
+from clickmd import md
+
+# Log-style output with automatic coloring
+md("""
+```log
+🚀 Starting process...
+📦 Installing dependencies...
+✅ Build successful!
+⚠️ Warning: deprecated API
+🛑 Error: connection failed
+```
+""")
+```
+
+## API Reference
+
+### Core Functions
+
+#### `md(text: str) -> None`
+Render markdown text with syntax highlighting.
+
+#### `echo(message, file=None, nl=True, err=False, color=None) -> None`
+Smart echo that auto-detects markdown and renders it.
+
+#### `render_markdown(text, text_lang="markdown", stream=None, use_colors=True) -> None`
+Low-level markdown rendering function.
+
+#### `get_renderer(stream=None, use_colors=True) -> MarkdownRenderer`
+Get a `MarkdownRenderer` instance.
+
+### Click Decorators (requires `click` package)
+
+When `click` is installed, these decorators are available:
+
+- `@clickmd.group()` - Create a command group
+- `@clickmd.command()` - Create a command
+- `@clickmd.option()` - Add an option
+- `@clickmd.argument()` - Add an argument
+- `@clickmd.pass_context` - Pass Click context
+- `clickmd.Choice` - Choice type
+- `clickmd.Path` - Path type
+
+### Constants
+
+- `CLICK_AVAILABLE: bool` - Whether Click is installed
+
+## Examples
+
+See the [examples/](examples/) directory for more usage examples:
+
+- `examples/basic.py` - Basic markdown rendering
+- `examples/cli_app.py` - Full CLI application with Click
+- `examples/custom_renderer.py` - Custom renderer configuration
+- `examples/logging.py` - Log-style colored output
+
+## Development
+
+```bash
+# Clone the repository
+git clone https://github.com/wronai/clickmd.git
+cd clickmd
+
+# Install development dependencies
+pip install -e ".[dev]"
+
+# Run tests
+make test
+
+# Run linter
+make lint
+
+# Format code
+make format
+```
+
+## License
+
+MIT License - see [LICENSE](LICENSE) for details.
+
+## Contributing
+
+Contributions are welcome! Please read our [Contributing Guide](CONTRIBUTING.md) first.
+
+## Related Projects
+
+- [Click](https://click.palletsprojects.com/) - Python CLI framework
+- [Rich](https://github.com/Textualize/rich) - Rich text and beautiful formatting
+- [Reclapp](https://github.com/wronai/contract) - Contract-first development platform