planefyi 0.1.0__tar.gz

planefyi-0.1.0/LICENSE

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

planefyi-0.1.0/PKG-INFO

@@ -0,0 +1,63 @@
+Metadata-Version: 2.4
+Name: planefyi
+Version: 0.1.0
+Summary: Aircraft models and specifications API client — planefyi.com
+Project-URL: Homepage, https://planefyi.com
+Project-URL: Documentation, https://planefyi.com/developers/
+Project-URL: Repository, https://github.com/fyipedia/planefyi
+Project-URL: Issues, https://github.com/fyipedia/planefyi/issues
+Project-URL: Changelog, https://github.com/fyipedia/planefyi/releases
+Author: FYIPedia
+License-Expression: MIT
+License-File: LICENSE
+Keywords: airbus,aircraft,airplane,aviation,boeing,manufacturer,plane,specification
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+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: Programming Language :: Python :: 3.14
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Provides-Extra: all
+Requires-Dist: httpx>=0.27; extra == 'all'
+Requires-Dist: mcp>=1.0; extra == 'all'
+Requires-Dist: rich>=13.0; extra == 'all'
+Requires-Dist: typer>=0.15; extra == 'all'
+Provides-Extra: api
+Requires-Dist: httpx>=0.27; extra == 'api'
+Provides-Extra: cli
+Requires-Dist: rich>=13.0; extra == 'cli'
+Requires-Dist: typer>=0.15; extra == 'cli'
+Provides-Extra: mcp
+Requires-Dist: mcp>=1.0; extra == 'mcp'
+Description-Content-Type: text/markdown
+
+# planefyi
+
+Aircraft models and specifications API client — [planefyi.com](https://planefyi.com)
+
+## Install
+
+```bash
+pip install planefyi
+```
+
+## Quick Start
+
+```python
+from planefyi.api import PlaneFYI
+
+with PlaneFYI() as api:
+    results = api.search("747")
+    print(results)
+```
+
+## License
+
+MIT

planefyi-0.1.0/README.md

@@ -0,0 +1,23 @@
+# planefyi
+
+Aircraft models and specifications API client — [planefyi.com](https://planefyi.com)
+
+## Install
+
+```bash
+pip install planefyi
+```
+
+## Quick Start
+
+```python
+from planefyi.api import PlaneFYI
+
+with PlaneFYI() as api:
+    results = api.search("747")
+    print(results)
+```
+
+## License
+
+MIT

planefyi-0.1.0/demo.tape

@@ -0,0 +1,34 @@
+# planefyi — Python API Client Demo
+Output demo.gif
+
+Set FontSize 20
+Set Width 1000
+Set Height 580
+Set Shell "zsh"
+Set Theme "Catppuccin Mocha"
+Set TypingSpeed 30ms
+Set Padding 24
+
+Type "uv run --with 'planefyi[api]' python3"
+Enter
+Sleep 2.5s
+
+Type "from planefyi.api import PlaneFYI"
+Enter
+Sleep 1s
+
+Type "client = PlaneFYI()"
+Enter
+Sleep 1s
+
+Type "# Search planefyi.com"
+Enter
+Sleep 0.5s
+
+Type "client.search('747')"
+Enter
+Sleep 2.5s
+
+Type "exit()"
+Enter
+Sleep 1s

planefyi-0.1.0/pyproject.toml

@@ -0,0 +1,86 @@
+[project]
+name = "planefyi"
+version = "0.1.0"
+description = "Aircraft models and specifications API client — planefyi.com"
+readme = "README.md"
+license = "MIT"
+requires-python = ">=3.10"
+authors = [{ name = "FYIPedia" }]
+keywords = [
+    "aircraft",
+    "airplane",
+    "aviation",
+    "specification",
+    "manufacturer",
+    "boeing",
+    "airbus",
+    "plane",
+]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+    "Typing :: Typed",
+    "Environment :: Console",
+]
+dependencies = []
+
+[project.optional-dependencies]
+api = ["httpx>=0.27"]
+cli = ["typer>=0.15", "rich>=13.0"]
+mcp = ["mcp>=1.0"]
+all = ["planefyi[api,cli,mcp]"]
+
+[project.scripts]
+planefyi = "planefyi.cli:app"
+
+[project.entry-points."mcp.servers"]
+planefyi = "planefyi.mcp_server:mcp"
+
+[project.urls]
+Homepage = "https://planefyi.com"
+Documentation = "https://planefyi.com/developers/"
+Repository = "https://github.com/fyipedia/planefyi"
+Issues = "https://github.com/fyipedia/planefyi/issues"
+Changelog = "https://github.com/fyipedia/planefyi/releases"
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/planefyi"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+addopts = "-v --tb=short"
+
+[tool.ruff]
+target-version = "py310"
+line-length = 100
+
+[tool.ruff.lint]
+select = ["E", "F", "I", "UP", "B", "SIM", "RUF"]
+ignore = ["RUF022"]
+
+[tool.mypy]
+python_version = "3.10"
+strict = true
+
+[dependency-groups]
+dev = [
+    "httpx>=0.27",
+    "mcp>=1.0",
+    "mypy>=1.19.1",
+    "pytest>=9.0.2",
+    "rich>=13.0",
+    "ruff>=0.15.4",
+    "typer>=0.15",
+]

planefyi-0.1.0/src/planefyi/__init__.py

@@ -0,0 +1,3 @@
+"""Python API client for planefyi.com."""
+
+__version__ = "0.1.0"

planefyi-0.1.0/src/planefyi/api.py

@@ -0,0 +1,58 @@
+"""HTTP API client for planefyi.com REST endpoints.
+
+Requires the ``api`` extra: ``pip install planefyi[api]``
+
+Usage::
+
+    from planefyi.api import PlaneFYI
+
+    with PlaneFYI() as api:
+        results = api.search("747")
+        print(results)
+"""
+
+from __future__ import annotations
+
+from typing import Any
+
+import httpx
+
+
+class PlaneFYI:
+    """API client for the planefyi.com REST API.
+
+    Args:
+        base_url: API base URL. Defaults to ``https://planefyi.com``.
+        timeout: Request timeout in seconds. Defaults to ``10.0``.
+    """
+
+    def __init__(
+        self,
+        base_url: str = "https://planefyi.com",
+        timeout: float = 10.0,
+    ) -> None:
+        self._client = httpx.Client(base_url=base_url, timeout=timeout)
+
+    def _get(self, path: str, **params: Any) -> dict[str, Any]:
+        resp = self._client.get(path, params={k: v for k, v in params.items() if v is not None})
+        resp.raise_for_status()
+        result: dict[str, Any] = resp.json()
+        return result
+
+    def search(self, query: str) -> dict[str, Any]:
+        """Search across all content.
+
+        Args:
+            query: Search term (e.g. ``"747"``).
+        """
+        return self._get("/api/search/", q=query)
+
+    def close(self) -> None:
+        """Close the underlying HTTP connection."""
+        self._client.close()
+
+    def __enter__(self) -> PlaneFYI:
+        return self
+
+    def __exit__(self, *_: object) -> None:
+        self.close()

planefyi-0.1.0/src/planefyi/cli.py

@@ -0,0 +1,19 @@
+"""Command-line interface for planefyi."""
+
+from __future__ import annotations
+
+import json
+
+import typer
+
+from planefyi.api import PlaneFYI
+
+app = typer.Typer(help="PlaneFYI — Aircraft models and specifications API client.")
+
+
+@app.command()
+def search(query: str) -> None:
+    """Search planefyi.com."""
+    with PlaneFYI() as api:
+        result = api.search(query)
+        typer.echo(json.dumps(result, indent=2))

planefyi-0.1.0/src/planefyi/mcp_server.py

@@ -0,0 +1,18 @@
+"""MCP server for planefyi."""
+
+from __future__ import annotations
+
+from typing import Any
+
+from mcp.server.fastmcp import FastMCP
+
+from planefyi.api import PlaneFYI
+
+mcp = FastMCP("planefyi")
+
+
+@mcp.tool()
+def search_planefyi(query: str) -> dict[str, Any]:
+    """Search planefyi.com for content matching the query."""
+    with PlaneFYI() as api:
+        return api.search(query)

planefyi-0.1.0/tests/test_basic.py

@@ -0,0 +1,7 @@
+"""Basic tests for planefyi."""
+
+from planefyi import __version__
+
+
+def test_version() -> None:
+    assert __version__ == "0.1.0"