mdb-cli 0.1.0__tar.gz

mdb_cli-0.1.0/.gitignore

@@ -0,0 +1,306 @@
+.worktrees
+
+# General
+.DS_Store
+__MACOSX/
+.AppleDouble
+.LSOverride
+Icon[
+]
+
+# Thumbnails
+._*
+
+# Files that might appear in the root of a volume
+.DocumentRevisions-V100
+.fseventsd
+.Spotlight-V100
+.TemporaryItems
+.Trashes
+.VolumeIcon.icns
+.com.apple.timemachine.donotpresent
+
+# Directories potentially created on remote AFP share
+.AppleDB
+.AppleDesktop
+Network Trash Folder
+Temporary Items
+.apdisk
+
+*~
+
+# temporary files which can be created if a process still has a handle open of a deleted file
+.fuse_hidden*
+
+# Metadata left by Dolphin file manager, which comes with KDE Plasma
+.directory
+
+# Linux trash folder which might appear on any partition or disk
+.Trash-*
+
+# .nfs files are created when an open file is removed but is still being accessed
+.nfs*
+
+# Log files created by default by the nohup command
+nohup.out
+
+# Windows thumbnail cache files
+Thumbs.db
+Thumbs.db:encryptable
+ehthumbs.db
+ehthumbs_vista.db
+
+# Dump file
+*.stackdump
+
+# Folder config file
+[Dd]esktop.ini
+
+# Recycle Bin used on file shares
+$RECYCLE.BIN/
+
+# Windows Installer files
+*.cab
+*.msi
+*.msix
+*.msm
+*.msp
+
+# Windows shortcuts
+*.lnk
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$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
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+# uv.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
+# poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+# pdm.lock
+# pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+# pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# Redis
+*.rdb
+*.aof
+*.pid
+
+# RabbitMQ
+mnesia/
+rabbitmq/
+rabbitmq-data/
+
+# ActiveMQ
+activemq-data/
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.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 found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#   and can be added to the global gitignore or merged into this file.  For a more nuclear
+#   option (not recommended) you can uncomment the following to ignore the entire idea folder.
+# .idea/
+
+# Abstra
+#   Abstra is an AI-powered process automation framework.
+#   Ignore directories containing user credentials, local state, and settings.
+#   Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#   Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#   that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#   and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#   you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Streamlit
+.streamlit/secrets.toml
+
+.vscode/*
+!.vscode/settings.json
+!.vscode/tasks.json
+!.vscode/launch.json
+!.vscode/extensions.json
+!.vscode/*.code-snippets
+!*.code-workspace
+
+# Node.js (interactive-demo)
+node_modules/
+out/
+*.tsbuildinfo
+
+# Generated interactive-demo bundle
+docs/assets/interactive-demo.js
+
+# mdb databases (tool-managed)
+.mdb/

mdb_cli-0.1.0/LICENSE

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

mdb_cli-0.1.0/PKG-INFO

@@ -0,0 +1,220 @@
+Metadata-Version: 2.4
+Name: mdb-cli
+Version: 0.1.0
+Summary: Markdown table workflows w/ SQLite powers ✨
+Project-URL: Homepage, https://atomanoid.github.io/mdb/
+Project-URL: Repository, https://github.com/atomanoid/mdb
+Project-URL: Documentation, https://atomanoid.github.io/mdb/
+Author: atomanoid
+License-Expression: MIT
+License-File: LICENSE
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Database
+Classifier: Topic :: Text Processing :: Markup :: Markdown
+Classifier: Typing :: Typed
+Requires-Python: >=3.11
+Provides-Extra: docs
+Requires-Dist: mkdocs-material>=9.5; extra == 'docs'
+Requires-Dist: mkdocs>=1.6; extra == 'docs'
+Requires-Dist: mkdocstrings[python]>=0.25; extra == 'docs'
+Description-Content-Type: text/markdown
+
+<p align="center">
+  <!-- <img src="https://raw.githubusercontent.com/atomanoid/mdb/main/docs/assets/floppy.svg" alt="floppy disk" width="128"> -->
+  <img src="https://raw.githubusercontent.com/gist/atomanoid/2e8135956d498969842907b1b149c72f/raw/f9d3aa40f4ebf7b347de617263ac1c7492bd6203/mdb-floppy.svg" alt="floppy disk" width="128">
+
+</p>
+
+<h1 align="center"><code>mdb-cli</code></h1>
+
+<h3 align="center">Markdown table workflows w/ SQLite powers ✨</h3>
+
+`mdb-cli` provides the `mdb` command-line tool to make markdown tables data-driven and queryable via SQL, using specialized co-located markers `💾 ...` with some embedded inline SQL queries to **define and dynamically view** our project-level data.
+
+- **Zero runtime dependencies** -- standard library only
+- **Simple integration** -- add markers and get running
+- **Python 3.11+** required
+
+## Installation
+
+Install from [PyPI](https://pypi.org/project/mdb-cli/):
+
+```bash
+# Using pipx (recommended)
+pipx install mdb-cli
+
+# Using uv (recommended)
+uv tool install mdb-cli
+
+# Using pip
+pip install mdb-cli
+```
+
+After installation, verify the tool is available:
+
+```bash
+mdb --help
+```
+
+For development installation, see [CONTRIBUTING.md](https://github.com/atomanoid/mdb/blob/main/CONTRIBUTING.md).
+
+## Basic Usage
+
+### Marker Syntax
+
+Place inline query markers above tables in your markdown file using the following format:
+
+```
+`💾 [scope] <directive> <sql-query>`
+```
+
+| Component     | Description                                             |
+| ------------- | ------------------------------------------------------- |
+| `💾`          | Marker prefix -- identifies the line as an `mdb` marker |
+| `[scope]`     | Optional named scope identifier of the dataset          |
+| `<directive>` | Directive: `🌀` (feed) or `💎` (tap)                    |
+| `<sql-query>` | SQL query to execute against the dataset                |
+
+## Directives
+
+| Directive | Name | Instruction                                                                                                       |
+| --------- | ---- | ----------------------------------------------------------------------------------------------------------------- |
+| `🌀`      | feed | Include the table below me as part of the dataset                                                                 |
+| `💎`      | tap  | Execute my SQL query on the dataset and render the results as the table below me (table auto-generated if absent) |
+
+> Under the hood, datasets are ingested into SQLite backing databases on which SQL queries are actually run.
+
+### Subcommands
+
+| Subcommand                | Behavior                                                                                                    |
+| ------------------------- | ----------------------------------------------------------------------------------------------------------- |
+| `mdb pull <sql-query>`    | process all `🌀` markers first (pulls), then outputs SQL query results in CSV format                        |
+| `mdb push`                | process all `🌀` markers first (pulls), then all `💎` markers after (pushes)                                |
+| `mdb push <sql-mutation>` | process all `🌀` markers first (pulls), execute the mutation, then all `🌀` and `💎` markers after (pushes) |
+
+### Example
+
+Given a project file `snacks.md` with the following content:
+
+```markdown
+# Snacks
+
+## Inventory
+
+`💾 🌀 SELECT * FROM snacks`
+
+| name               | vibe               | qty |
+| ------------------ | ------------------ | --- |
+| Hot Cheese Popcorn | chaos energy       | 3   |
+| Pocky              | elegant simplicity | 12  |
+| Takis              | rolled-up danger   | 7   |
+| Goldfish           | the people's snack | 41  |
+
+## Low stock
+
+`💾 💎 SELECT name, qty FROM snacks WHERE qty < 10 ORDER BY qty`
+```
+
+After running:
+
+```bash
+mdb push
+```
+
+We'll have the `snacks.md` updated to the following content:
+
+```markdown
+# Snacks
+
+## Inventory
+
+`💾 🌀 SELECT * FROM snacks`
+
+| name               | vibe               | qty |
+| ------------------ | ------------------ | --- |
+| Hot Cheese Popcorn | chaos energy       | 3   |
+| Pocky              | elegant simplicity | 12  |
+| Takis              | rolled-up danger   | 7   |
+| Goldfish           | the people's snack | 41  |
+
+## Low stock
+
+`💾 💎 SELECT name, qty FROM snacks WHERE qty < 10 ORDER BY qty`
+
+| name               | qty |
+| ------------------ | --- |
+| Hot Cheese Popcorn | 3   |
+| Takis              | 7   |
+```
+
+The 🌀 (feed) marker ingests the snacks data into the (unscoped) dataset, then the 💎 (tap) marker executes the query and surfaces only the snacks running low in stock.
+
+---
+
+Additionally, after running:
+
+```bash
+mdb pull "SELECT SUM(qty) as total_snacks FROM snacks"
+```
+
+We'll get the output:
+
+```
+total_snacks
+63
+```
+
+The 🌀 (feed) marker again ingests the snacks data into the dataset, but the 💎 (tap) marker is not processed.
+
+---
+
+We can also mutate data directly. Running:
+
+```bash
+mdb push "UPDATE snacks SET qty = qty + 20 WHERE name = 'Takis'"
+```
+
+The 🌀 (feed) marker again ingests the snacks data into the dataset, applies the UPDATE, then both 🌀 (feed) and 💎 (tap) markers push fresh results back:
+
+```markdown
+## Inventory
+
+`💾 🌀 SELECT * FROM snacks`
+
+| name               | vibe               | qty |
+| ------------------ | ------------------ | --- |
+| Hot Cheese Popcorn | chaos energy       | 3   |
+| Pocky              | elegant simplicity | 12  |
+| Takis              | rolled-up danger   | 27  |
+| Goldfish           | the people's snack | 41  |
+
+## Low stock
+
+`💾 💎 SELECT name, qty FROM snacks WHERE qty < 10 ORDER BY qty`
+
+| name               | qty |
+| ------------------ | --- |
+| Hot Cheese Popcorn | 3   |
+```
+
+Takis got restocked to 27 and dropped off the low-stock list — all from a single command.
+
+## Agent Support
+
+`mdb-cli` includes a built-in agent skill. Install it:
+
+```
+mdb init                          # default: .mdb/skills/mdb/SKILL.md
+mdb init .claude/skills           # Claude Code: .claude/skills/mdb/SKILL.md
+mdb init .opencode/skills         # OpenCode: .opencode/skills/mdb/SKILL.md
+mdb init path/to/agent/skills     # any agent: path/to/agent/skills/mdb/SKILL.md
+```
+
+Within a session, invoke the `/mdb` slash command to access a comprehensive reference covering marker syntax, subcommand workflows, templates for common operations, and an error reference guide. The skill provides everything an AI coding assistant needs to construct and debug mdb markers without leaving the editor.