{"id":31695222,"url":"https://github.com/matrixxboy/apimatic","last_synced_at":"2026-01-20T17:00:09.902Z","repository":{"id":311621616,"uuid":"1044199561","full_name":"Matrixxboy/Apimatic","owner":"Matrixxboy","description":"Apimatic automates the creation of API documentation. This module intelligently fetches data from your APIs and compiles it into a clear, organized .md file, eliminating manual updates. It ensures your documentation is always accurate and up-to-date, freeing you to focus on development.","archived":false,"fork":false,"pushed_at":"2025-09-01T05:06:43.000Z","size":99,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-10-08T16:50:06.974Z","etag":null,"topics":["ai","airflow","api","explainer","gemini-api","groq-api","npm","ollama","openai-api","python-package","pytohn3"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Matrixxboy.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-08-25T10:29:04.000Z","updated_at":"2025-09-01T11:40:20.000Z","dependencies_parsed_at":"2025-08-25T16:25:48.857Z","dependency_job_id":"e8e33738-8cac-4f36-b0b8-01c773bce6eb","html_url":"https://github.com/Matrixxboy/Apimatic","commit_stats":null,"previous_names":["matrixxboy/apimatic"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/Matrixxboy/Apimatic","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Matrixxboy%2FApimatic","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Matrixxboy%2FApimatic/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Matrixxboy%2FApimatic/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Matrixxboy%2FApimatic/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Matrixxboy","download_url":"https://codeload.github.com/Matrixxboy/Apimatic/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Matrixxboy%2FApimatic/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28607624,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-20T16:10:39.856Z","status":"ssl_error","status_checked_at":"2026-01-20T16:10:39.493Z","response_time":117,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["ai","airflow","api","explainer","gemini-api","groq-api","npm","ollama","openai-api","python-package","pytohn3"],"created_at":"2025-10-08T16:45:23.906Z","updated_at":"2026-01-20T17:00:09.872Z","avatar_url":"https://github.com/Matrixxboy.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Apimatic 🚀  \n\n[![Matrixxboy](https://img.shields.io/badge/github-Matrixxboy-purple.svg)](https://github.com/Matrixxboy)\n[![PyPI version](https://badge.fury.io/py/Apimatic.svg)](https://pypi.org/project/Apimatic/)\n[![Downloads](https://static.pepy.tech/badge/Apimatic)](https://pepy.tech/project/Apimatic)\n[![Python Version](https://img.shields.io/badge/python-%3E%3D3.9-blue)](https://pypi.org/project/Apimatic/)\n[![License](https://img.shields.io/badge/License-MIT-green?style=flat-circle)](LICENSE)\n\u003c!-- PyPI Card --\u003e\n\u003ca href=\"https://pypi.org/project/Apimatic/\" target=\"_blank\"\u003e\n  \u003cimg src=\"https://img.shields.io/pypi/v/Apimatic?color=3775A9\u0026logo=python\u0026label=Apimatic\u0026style=for-the-badge\" alt=\"pypi version\" /\u003e\n\u003c/a\u003e\n\u003c!-- NPM Card --\u003e\n\u003ca href=\"https://www.npmjs.com/package/apimatic-cli\" target=\"_blank\"\u003e\n  \u003cimg src=\"https://img.shields.io/npm/v/apimatic-cli?color=CB3837\u0026logo=npm\u0026label=apimatic-cli\u0026style=for-the-badge\" alt=\"npm version\" /\u003e\n\u003c/a\u003e\n\n\nA tool to **automatically generate beautiful and comprehensive API documentation** (Markdown) from your source code.  \nSupports **Flask, FastAPI, and more frameworks** with optional **AI-powered enhancements via Ollama, OpenAI, Google Gemini, and Groq**.  \n\n---\n\n## 📦 Installation\n\n```bash\n# Run this in your global environment\npip install Apimatic\n```\n\nUpgrade to the latest version:\n\n```bash\npip install --upgrade Apimatic\n```\n\n---\n\n## ⚡ Usage\n\nApimatic now uses commands to separate actions.\n\n**1. Generate Documentation:**\n```bash\napimatic generate [OPTIONS]\n```\n\n**2. Configure API Keys:**\n```bash\napimatic config [OPTIONS]\n```\n\n---\n\n## 🔑 Configuration\n\nTo use AI enhancements from providers like OpenAI, Google Gemini, or Groq, you must set an API key.\n\n```bash\n# Set your OpenAI API key\napimatic config --set-openai-key YOUR_API_KEY\n\n# Set your Google Gemini API key\napimatic config --set-gemini-key YOUR_API_KEY\n\n# Set your Groq API key\napimatic config --set-groq-key YOUR_API_KEY\n```\nThe key will be stored securely in your home directory.\n\n---\n\n## ⚙️ Generation Options\n\n| Option | Description |\n| --- | --- |\n| `-h, --help` | Show help message and exit |\n| `--src SRC` | Root directory of the project to scan (Default: current directory) |\n| `--framework [FRAMEWORK ...]` | Force a specific framework (`flask`, `fastapi`, etc.). If omitted, auto-detected |\n| `--format {markdown}` | Output format (Default: `markdown`) |\n| `--output OUTPUT` | Path for the generated output file (Default: `API_Docs.md`) |\n| `--use-ollama` | Enhance with a local Ollama model |\n| `--ollama-model MODEL` | Ollama model to use (e.g., `phi3:mini`) |\n| `--use-openai` | Enhance with an OpenAI model |\n| `--openai-model MODEL` | OpenAI model to use (e.g., `gpt-4o-mini`) |\n| `--use-google-gemini` | Enhance with a Google Gemini model |\n| `--google-gemini-model MODEL` | Gemini model to use (e.g., `gemini-1.5-flash`) |\n| `--use-groq` | Enhance with a Groq model |\n| `--groq-model MODEL` | Groq model to use (e.g., `llama3-8b-8192`) |\n\n---\n\n## 📝 Examples\n\n**Basic Generation:**\n```bash\n# Generate Markdown docs from the current project\napimatic generate --src . --output API_Docs.md\n```\n\n**Force Framework:**\n```bash\n# Force detection for a Flask app\napimatic generate --src ./my_flask_app --framework flask\n```\n\n**AI-Enhanced Documentation:**\n\nFirst, set your key:\n```bash\napimatic config --set-openai-key sk-xxxxxxxx\n```\nThen, generate with enhancement:\n```bash\n# Use OpenAI's gpt-4o-mini model\napimatic generate --src . --use-openai --openai-model gpt-4o-mini\n\n# Use Google Gemini\napimatic generate --src . --use-google-gemini\n\n# Use Groq's fast Mixtral model\napimatic generate --src . --use-groq\n\n# Use a local Ollama model\napimatic generate --src . --use-ollama --ollama-model phi3:mini\n```\n\n---\n\n## 🤖 Recommended AI Models\n\n| Provider | Recommended Model | Notes |\n| --- | --- | --- |\n| **Ollama (Local)** | `phi3:mini`, `llama3:8b` | Fast, free, and runs on your machine. Great for privacy. |\n| **OpenAI** | `gpt-4o-mini` | Excellent balance of cost, speed, and intelligence. |\n| **Google Gemini** | `gemini-1.5-flash` | Fast and cost-effective model from Google. |\n| **Groq** | `llama3-8b-8192` | Incredibly fast inference speeds. |\n\n---\n\n## 🤝 Contributing\n\nContributions are welcome! Please fork the repo, make your changes, and submit a PR.\n\n---\n\n## 📄 License\n\nThis project is licensed under the [MIT License](LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmatrixxboy%2Fapimatic","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmatrixxboy%2Fapimatic","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmatrixxboy%2Fapimatic/lists"}