Add initial implementation of ask2api CLI tool

atasoglu · atasoglu · commit 41769b0efed4 · 2025-12-27T11:02:20.000+03:00
- Created `ask2api.py` for converting natural language prompts into structured JSON API responses using OpenAI's API.
- Added `README.md` with usage instructions and examples.
- Included `schema.json` for defining the expected JSON structure.
- Introduced `.gitignore` to exclude unnecessary files and directories.
- Added `.pre-commit-config.yaml` for code quality checks using Ruff.
- Defined project metadata in `pyproject.toml` and `uv.lock` for dependency management.
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,216 @@
+# 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
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -0,0 +1,10 @@
+repos:
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.8.4
+    hooks:
+      - id: ruff
+        args: [--fix]
+        types: [python]
+      - id: ruff-format
+        types: [python]
+
diff --git a/README.md b/README.md
@@ -0,0 +1,84 @@
+# ask2api
+
+`ask2api` is a minimal Python CLI tool that turns natural language prompts into structured API-style JSON responses using LLM.
+
+It allows you to define a JSON Schema and force the model to answer strictly in that format.
+
+## Why ask2api?
+
+Because LLMs are no longer just chatbots, they are also programmable API engines.
+
+`ask2api` lets you use them that way. 🚀
+
+Key features:
+
+- Minimal dependencies  
+- CLI first  
+- Prompt → API behavior  
+- No markdown, no explanations, only valid JSON  
+- Designed for automation pipelines and AI-driven backend workflows
+
+## Installation
+
+```bash
+pip install ask2api
+```
+
+Set your OpenAI key:
+
+```bash
+export OPENAI_API_KEY="your_api_key"
+```
+
+## Usage
+
+Instead of asking:
+
+> *“Where is the capital of France?”*
+
+and receiving free-form text, you can do this:
+
+```bash
+ask2api -p "Where is the capital of France?" -sf schema.json
+```
+
+And get a structured API response:
+
+```json
+{
+  "country": "France",
+  "city": "Paris"
+}
+```
+
+## How it works
+
+1. You define the desired output structure using a JSON Schema.
+2. The schema is passed to the model using OpenAI’s `json_schema` structured output format.
+3. The system prompt enforces strict JSON-only responses.
+4. The CLI prints the API-ready JSON output.
+
+The model is treated as a deterministic API function.
+
+## Example schema
+
+Create a file named `schema.json`:
+
+```json
+{
+  "type": "object",
+  "properties": {
+    "country": { "type": "string" },
+    "city": { "type": "string" }
+  },
+  "required": ["country", "city"]
+}
+```
+
+## Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request.
+
+## License
+
+MIT
diff --git a/ask2api.py b/ask2api.py
@@ -0,0 +1,52 @@
+import argparse
+import json
+import os
+import requests
+
+API_KEY = os.getenv("OPENAI_API_KEY")
+OPENAI_URL = "https://api.openai.com/v1/chat/completions"
+
+
+def main():
+    parser = argparse.ArgumentParser()
+    parser.add_argument("-p", "--prompt", required=True)
+    parser.add_argument("-sf", "--schema-file", required=True)
+    args = parser.parse_args()
+
+    with open(args.schema_file, "r", encoding="utf-8") as f:
+        schema = json.load(f)
+
+    system_prompt = """
+    You are a JSON API engine.
+
+    You must answer every user request as a valid API response that strictly
+    follows the given JSON schema.
+
+    Never return markdown, comments or extra text.
+    """
+
+    payload = {
+        "model": "gpt-4.1",
+        "messages": [
+            {"role": "system", "content": system_prompt},
+            {"role": "user", "content": args.prompt},
+        ],
+        "response_format": {
+            "type": "json_schema",
+            "json_schema": {"name": "ask2api_schema", "schema": schema},
+        },
+        "temperature": 0,
+    }
+
+    headers = {"Authorization": f"Bearer {API_KEY}", "Content-Type": "application/json"}
+
+    r = requests.post(OPENAI_URL, headers=headers, json=payload)
+    r.raise_for_status()
+
+    result = r.json()["choices"][0]["message"]["content"]
+    parsed_result = json.loads(result)
+    print(json.dumps(parsed_result, indent=2, ensure_ascii=False))
+
+
+if __name__ == "__main__":
+    main()
diff --git a/pyproject.toml b/pyproject.toml
@@ -0,0 +1,29 @@
+[project]
+name = "ask2api"
+version = "0.1.0"
+description = "A minimal CLI tool that turns natural language into instant APIs."
+readme = "README.md"
+authors = [
+    {name = "Ahmet Atasoglu", email = "ahmetatasoglu98@gmail.com"},
+]
+requires-python = ">=3.9"
+dependencies = [
+    "requests",
+]
+
+[project.scripts]
+ask2api = "ask2api:main"
+
+[project.urls]
+Homepage = "https://github.com/atasoglu/ask2api"
+Repository = "https://github.com/atasoglu/ask2api.git"
+
+[project.optional-dependencies]
+dev = [
+    "pre-commit",
+]
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
diff --git a/schema.json b/schema.json
diff --git a/uv.lock b/uv.lock
