ghostcrawl 2.1.0__tar.gz

ghostcrawl-2.1.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 GhostCrawl
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

ghostcrawl-2.1.0/MANIFEST.in

@@ -0,0 +1,9 @@
+include README.md
+include LICENSE
+recursive-include ghostcrawl py.typed *.pyi
+prune tests
+prune ghostcrawl/tests
+prune examples
+prune _operator
+recursive-exclude ghostcrawl reference.md
+global-exclude __pycache__ *.pyc

ghostcrawl-2.1.0/PKG-INFO

@@ -0,0 +1,211 @@
+Metadata-Version: 2.4
+Name: ghostcrawl
+Version: 2.1.0
+Summary: Official Python SDK for the Ghostcrawl local orchestration API.
+Author: Ghostcrawl
+License: Apache-2.0
+Project-URL: Homepage, https://github.com/ghostcrawl/ghostcrawl
+Keywords: ghostcrawl,scraping,browser,automation,agent
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software 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: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: httpx>=0.28.1
+Requires-Dist: pydantic>=2.13
+Requires-Dist: typer>=0.12
+Requires-Dist: mcp>=1.27.1
+Provides-Extra: dev
+Requires-Dist: pytest>=8.0; extra == "dev"
+Requires-Dist: respx>=0.23.1; extra == "dev"
+Requires-Dist: pytest-asyncio>=0.23; extra == "dev"
+Dynamic: license-file
+
+# ghostcrawl — Python SDK + CLI
+
+Typed Python client and `ghostcrawl` CLI for the GhostCrawl REST + MCP surface.
+Full coverage of scrape, crawl, sessions, datasets, recordings, profiles,
+webhooks, and the MCP tools.
+
+Public engine names are `chrome`, `firefox`, and `webkit`. There are no other engine
+names — `engine="auto"` lets the orchestrator pick.
+
+## Install
+
+```bash
+pip install ghostcrawl
+```
+
+Requires Python 3.10+. Runtime dependencies: `httpx>=0.28.1`, `pydantic>=2.13`,
+`typer>=0.12`, `mcp>=1.27.1`.
+
+## Quickstart — Identity (v1.6 SaaS)
+
+The v1.6 surface adds the `ghostcrawl init / identity` workflow for generating
+authenticated, opaque identity envelopes consumed by the engine binary.
+
+### CLI
+
+```bash
+# One-time setup: stores API key to ~/.config/ghostcrawl/config.toml
+ghostcrawl init
+
+# Request an identity envelope
+ghostcrawl identity --os ios --browser safari --device iphone-15-pro
+```
+
+Output is an opaque JSON envelope with an AES-256-GCM encrypted payload.
+The payload is not user-decodable — it is consumed verbatim by the browser binary.
+
+### Python SDK
+
+```python
+from ghostcrawl import Ghostcrawl
+
+client = Ghostcrawl(api_key="gc_...")
+envelope = client.identity(
+    claim_os="ios",
+    claim_browser="safari",
+    device_model="iphone-15-pro",
+)
+
+# Pass to the engine binary; do not attempt to decode ciphertext
+print(envelope.payload.alg)        # 'AES-256-GCM'
+print(envelope.payload.key_id)     # '16-char-hex-id'
+```
+
+> **Note:** The `payload.ciphertext` field is an opaque base64 string. It is
+> designed to be passed directly to the engine binary, which handles decryption
+> using a server-derived key. The SDK never decodes or inspects the ciphertext.
+
+## Quickstart — SDK (sync)
+
+```python
+from ghostcrawl import GhostcrawlClient
+
+client = GhostcrawlClient(api_key="YOUR_KEY", base_url="https://api.ghostcrawl.io")
+
+# Scrape
+result = client.page.scrape(url="https://example.com", engine="chrome")
+print(result)
+
+# Start a crawl run
+run = client.crawl_runs.create(
+    seed_url="https://example.com",
+    max_depth=2,
+    max_pages=50,
+)
+print(run.run_id)
+
+# List sessions
+sessions = client.sessions.list()
+for s in sessions.items:
+    print(s.session_id, s.status)
+```
+
+## Quickstart — SDK (async)
+
+```python
+import asyncio
+from ghostcrawl import AsyncGhostcrawlClient
+
+async def main():
+    async with AsyncGhostcrawlClient(api_key="YOUR_KEY") as client:
+        result = await client.page.scrape(url="https://example.com")
+        print(result)
+
+asyncio.run(main())
+```
+
+## Quickstart — CLI
+
+```bash
+export GHOSTCRAWL_API_KEY=your-token
+
+# Scrape a URL (JSON to stdout)
+ghostcrawl scrape https://example.com
+
+# Start a crawl run
+ghostcrawl crawl https://example.com --max-depth 2 --out crawl.json
+
+# List sessions
+ghostcrawl session list
+
+# Auth helpers
+ghostcrawl auth whoami
+ghostcrawl auth login
+```
+
+## MCP Wrapper
+
+Typed wrapper over the MCP streamable-HTTP transport.
+
+```python
+import asyncio
+from ghostcrawl.mcp import GhostcrawlMCPClient
+
+async def main():
+    mcp = GhostcrawlMCPClient(
+        mcp_url="https://api.ghostcrawl.io/mcp",
+        api_key="YOUR_KEY",
+    )
+    await mcp.connect()
+
+    # Navigate
+    result = await mcp.navigate(url="https://example.com")
+
+    # Act on page
+    result = await mcp.act(goal="Find the contact email")
+
+    # Extract structured data
+    result = await mcp.extract(schema={"type": "object", "properties": {"title": {"type": "string"}}})
+
+    # Screenshot
+    shot = await mcp.screenshot()
+
+    # Health check
+    pong = await mcp.ping()
+
+    await mcp.close()
+
+asyncio.run(main())
+```
+
+## Resource Coverage
+
+| Resource | Client attribute | Endpoints covered |
+|----------|-----------------|-------------------|
+| Page (scrape/crawl/agent) | `client.page` | scrape, map, screenshot, pdf, search |
+| Sessions | `client.sessions` | list, get, create, end, navigate, pause, resume |
+| Crawl runs | `client.crawl_runs` | create, list, get, cancel |
+| Datasets | `client.datasets` | list, get, create, delete, append |
+| Recordings | `client.recordings` | list, get, create, delete |
+| Profiles | `client.profiles` | list, get, create, delete |
+| Webhooks | `client.webhooks` | list, get, create, delete, test, queue |
+| Storage states | `client.storage_states` | list, get, import, export |
+| Script | `client.script` | run |
+| Observability | `client.observability` | metrics, health |
+| Auth / tokens | `client.auth`, `client.auth_tokens` | login, refresh, token CRUD |
+| Budgets | `client.budgets` | get, update |
+| Audit log | `client.audit` | list events |
+
+## Authentication
+
+```python
+client = GhostcrawlClient(
+    api_key="gc_live_...",
+    base_url="https://api.ghostcrawl.io",  # default — override for self-hosted
+)
+```
+
+Every request sends `Authorization: Bearer <api_key>` and `X-API-Key: <api_key>`.
+
+## License
+
+Apache-2.0

ghostcrawl-2.1.0/README.md

@@ -0,0 +1,182 @@
+# ghostcrawl — Python SDK + CLI
+
+Typed Python client and `ghostcrawl` CLI for the GhostCrawl REST + MCP surface.
+Full coverage of scrape, crawl, sessions, datasets, recordings, profiles,
+webhooks, and the MCP tools.
+
+Public engine names are `chrome`, `firefox`, and `webkit`. There are no other engine
+names — `engine="auto"` lets the orchestrator pick.
+
+## Install
+
+```bash
+pip install ghostcrawl
+```
+
+Requires Python 3.10+. Runtime dependencies: `httpx>=0.28.1`, `pydantic>=2.13`,
+`typer>=0.12`, `mcp>=1.27.1`.
+
+## Quickstart — Identity (v1.6 SaaS)
+
+The v1.6 surface adds the `ghostcrawl init / identity` workflow for generating
+authenticated, opaque identity envelopes consumed by the engine binary.
+
+### CLI
+
+```bash
+# One-time setup: stores API key to ~/.config/ghostcrawl/config.toml
+ghostcrawl init
+
+# Request an identity envelope
+ghostcrawl identity --os ios --browser safari --device iphone-15-pro
+```
+
+Output is an opaque JSON envelope with an AES-256-GCM encrypted payload.
+The payload is not user-decodable — it is consumed verbatim by the browser binary.
+
+### Python SDK
+
+```python
+from ghostcrawl import Ghostcrawl
+
+client = Ghostcrawl(api_key="gc_...")
+envelope = client.identity(
+    claim_os="ios",
+    claim_browser="safari",
+    device_model="iphone-15-pro",
+)
+
+# Pass to the engine binary; do not attempt to decode ciphertext
+print(envelope.payload.alg)        # 'AES-256-GCM'
+print(envelope.payload.key_id)     # '16-char-hex-id'
+```
+
+> **Note:** The `payload.ciphertext` field is an opaque base64 string. It is
+> designed to be passed directly to the engine binary, which handles decryption
+> using a server-derived key. The SDK never decodes or inspects the ciphertext.
+
+## Quickstart — SDK (sync)
+
+```python
+from ghostcrawl import GhostcrawlClient
+
+client = GhostcrawlClient(api_key="YOUR_KEY", base_url="https://api.ghostcrawl.io")
+
+# Scrape
+result = client.page.scrape(url="https://example.com", engine="chrome")
+print(result)
+
+# Start a crawl run
+run = client.crawl_runs.create(
+    seed_url="https://example.com",
+    max_depth=2,
+    max_pages=50,
+)
+print(run.run_id)
+
+# List sessions
+sessions = client.sessions.list()
+for s in sessions.items:
+    print(s.session_id, s.status)
+```
+
+## Quickstart — SDK (async)
+
+```python
+import asyncio
+from ghostcrawl import AsyncGhostcrawlClient
+
+async def main():
+    async with AsyncGhostcrawlClient(api_key="YOUR_KEY") as client:
+        result = await client.page.scrape(url="https://example.com")
+        print(result)
+
+asyncio.run(main())
+```
+
+## Quickstart — CLI
+
+```bash
+export GHOSTCRAWL_API_KEY=your-token
+
+# Scrape a URL (JSON to stdout)
+ghostcrawl scrape https://example.com
+
+# Start a crawl run
+ghostcrawl crawl https://example.com --max-depth 2 --out crawl.json
+
+# List sessions
+ghostcrawl session list
+
+# Auth helpers
+ghostcrawl auth whoami
+ghostcrawl auth login
+```
+
+## MCP Wrapper
+
+Typed wrapper over the MCP streamable-HTTP transport.
+
+```python
+import asyncio
+from ghostcrawl.mcp import GhostcrawlMCPClient
+
+async def main():
+    mcp = GhostcrawlMCPClient(
+        mcp_url="https://api.ghostcrawl.io/mcp",
+        api_key="YOUR_KEY",
+    )
+    await mcp.connect()
+
+    # Navigate
+    result = await mcp.navigate(url="https://example.com")
+
+    # Act on page
+    result = await mcp.act(goal="Find the contact email")
+
+    # Extract structured data
+    result = await mcp.extract(schema={"type": "object", "properties": {"title": {"type": "string"}}})
+
+    # Screenshot
+    shot = await mcp.screenshot()
+
+    # Health check
+    pong = await mcp.ping()
+
+    await mcp.close()
+
+asyncio.run(main())
+```
+
+## Resource Coverage
+
+| Resource | Client attribute | Endpoints covered |
+|----------|-----------------|-------------------|
+| Page (scrape/crawl/agent) | `client.page` | scrape, map, screenshot, pdf, search |
+| Sessions | `client.sessions` | list, get, create, end, navigate, pause, resume |
+| Crawl runs | `client.crawl_runs` | create, list, get, cancel |
+| Datasets | `client.datasets` | list, get, create, delete, append |
+| Recordings | `client.recordings` | list, get, create, delete |
+| Profiles | `client.profiles` | list, get, create, delete |
+| Webhooks | `client.webhooks` | list, get, create, delete, test, queue |
+| Storage states | `client.storage_states` | list, get, import, export |
+| Script | `client.script` | run |
+| Observability | `client.observability` | metrics, health |
+| Auth / tokens | `client.auth`, `client.auth_tokens` | login, refresh, token CRUD |
+| Budgets | `client.budgets` | get, update |
+| Audit log | `client.audit` | list events |
+
+## Authentication
+
+```python
+client = GhostcrawlClient(
+    api_key="gc_live_...",
+    base_url="https://api.ghostcrawl.io",  # default — override for self-hosted
+)
+```
+
+Every request sends `Authorization: Bearer <api_key>` and `X-API-Key: <api_key>`.
+
+## License
+
+Apache-2.0