geekflare-api 0.1.0__tar.gz

geekflare_api-0.1.0/LICENSE

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

geekflare_api-0.1.0/PKG-INFO

@@ -0,0 +1,86 @@
+Metadata-Version: 2.4
+Name: geekflare-api
+Version: 0.1.0
+Summary: Official Python SDK for Geekflare API
+Home-page: 
+Author: OpenAPI Generator community
+Author-email: Geekflare <support@geekflare.com>
+License: MIT
+Project-URL: Homepage, https://github.com/geekflare/geekflare-api-python
+Project-URL: Documentation, https://docs.geekflare.com/api/intro
+Project-URL: Repository, https://github.com/geekflare/geekflare-api-python
+Project-URL: Issues, https://github.com/geekflare/geekflare-api-python/issues
+Keywords: geekflare,api,sdk,scraping,screenshot,dns,search
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: urllib3>=1.25.3
+Requires-Dist: python-dateutil>=2.8.2
+Requires-Dist: pydantic>=2.0.0
+Requires-Dist: typing-extensions>=4.7.1
+Dynamic: author
+Dynamic: license-file
+
+# geekflare-api
+
+Official Python SDK for the [Geekflare API](https://geekflare.com/api/).
+
+## Installation
+
+```bash
+pip install geekflare-api
+```
+
+## Quick Start
+
+```python
+from geekflare_api.client import GeekflareClient
+from geekflare_api.models import PingDto
+
+with GeekflareClient(api_key="your-api-key") as client:
+    result = client.ping(PingDto(url="https://google.com"))
+    print(result)
+```
+
+## Available Methods
+
+| Method                        | Description                    |
+| ----------------------------- | ------------------------------ |
+| `client.meta_scrape(body)`    | Scrape meta tags from a URL    |
+| `client.web_scrape(body)`     | Scrape web page content        |
+| `client.dns_record(body)`     | Look up DNS records            |
+| `client.screenshot(body)`     | Take a screenshot of a URL     |
+| `client.site_status(body)`    | Check if a site is up or down  |
+| `client.redirect_check(body)` | Check redirect chain of a URL  |
+| `client.broken_link(body)`    | Find broken links on a page    |
+| `client.url2_pdf(body)`       | Convert a URL to PDF           |
+| `client.open_ports(body)`     | Scan open ports on a host      |
+| `client.tls_scan(body)`       | Scan TLS/SSL configuration     |
+| `client.load_time(body)`      | Test page load time            |
+| `client.mixed_content(body)`  | Check for mixed content issues |
+| `client.dns_sec(body)`        | Check DNSSEC configuration     |
+| `client.mtr(body)`            | Perform MTR network test       |
+| `client.ping(body)`           | Ping a host                    |
+| `client.lighthouse(body)`     | Run Lighthouse audit           |
+| `client.search(body)`         | Perform a web search           |
+
+## Error Handling
+
+```python
+from geekflare_api.exceptions import ApiException
+
+try:
+    result = client.ping(PingDto(url="https://google.com"))
+except ApiException as e:
+    print(f"API error {e.status}: {e.reason}")
+```
+
+## Links
+
+- [API Documentation](https://docs.geekflare.com/api/intro)
+- [Geekflare API](https://dash.geekflare.com)
+- [Report Issues](https://github.com/geekflare/geekflare-api-python/issues)
+
+## License
+
+MIT

geekflare_api-0.1.0/README.md

@@ -0,0 +1,63 @@
+# geekflare-api
+
+Official Python SDK for the [Geekflare API](https://geekflare.com/api/).
+
+## Installation
+
+```bash
+pip install geekflare-api
+```
+
+## Quick Start
+
+```python
+from geekflare_api.client import GeekflareClient
+from geekflare_api.models import PingDto
+
+with GeekflareClient(api_key="your-api-key") as client:
+    result = client.ping(PingDto(url="https://google.com"))
+    print(result)
+```
+
+## Available Methods
+
+| Method                        | Description                    |
+| ----------------------------- | ------------------------------ |
+| `client.meta_scrape(body)`    | Scrape meta tags from a URL    |
+| `client.web_scrape(body)`     | Scrape web page content        |
+| `client.dns_record(body)`     | Look up DNS records            |
+| `client.screenshot(body)`     | Take a screenshot of a URL     |
+| `client.site_status(body)`    | Check if a site is up or down  |
+| `client.redirect_check(body)` | Check redirect chain of a URL  |
+| `client.broken_link(body)`    | Find broken links on a page    |
+| `client.url2_pdf(body)`       | Convert a URL to PDF           |
+| `client.open_ports(body)`     | Scan open ports on a host      |
+| `client.tls_scan(body)`       | Scan TLS/SSL configuration     |
+| `client.load_time(body)`      | Test page load time            |
+| `client.mixed_content(body)`  | Check for mixed content issues |
+| `client.dns_sec(body)`        | Check DNSSEC configuration     |
+| `client.mtr(body)`            | Perform MTR network test       |
+| `client.ping(body)`           | Ping a host                    |
+| `client.lighthouse(body)`     | Run Lighthouse audit           |
+| `client.search(body)`         | Perform a web search           |
+
+## Error Handling
+
+```python
+from geekflare_api.exceptions import ApiException
+
+try:
+    result = client.ping(PingDto(url="https://google.com"))
+except ApiException as e:
+    print(f"API error {e.status}: {e.reason}")
+```
+
+## Links
+
+- [API Documentation](https://docs.geekflare.com/api/intro)
+- [Geekflare API](https://dash.geekflare.com)
+- [Report Issues](https://github.com/geekflare/geekflare-api-python/issues)
+
+## License
+
+MIT

geekflare_api-0.1.0/geekflare_api/__init__.py

@@ -0,0 +1,215 @@
+# coding: utf-8
+
+# flake8: noqa
+
+"""
+    Geekflare API
+
+    Official OpenAPI specification for all Geekflare API endpoints.
+
+    The version of the OpenAPI document: 1.0.0
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+__version__ = "0.1.0"
+
+# Define package exports
+__all__ = [
+    "ApiToolApi",
+    "ApiResponse",
+    "ApiClient",
+    "Configuration",
+    "OpenApiException",
+    "ApiTypeError",
+    "ApiValueError",
+    "ApiKeyError",
+    "ApiAttributeError",
+    "ApiException",
+    "BaseErrorResponseDto",
+    "BrokenLinkDto",
+    "BrokenLinkMetaDto",
+    "BrokenLinkResponseDto",
+    "BrokenLinkSummaryDto",
+    "DefaultExtractionFieldDto",
+    "DnsMetaDto",
+    "DnsRecordDto",
+    "DnsRecordResponseDto",
+    "DnsSecDataDto",
+    "DnsSecDto",
+    "DnsSecMetaDto",
+    "DnsSecResponseDto",
+    "ExtractionSchemaDto",
+    "ExtractionSchemaDtoFieldsInner",
+    "HealthResponseDto",
+    "ImageSearchResponseDto",
+    "ImageSearchResultItemDto",
+    "LighthouseDto",
+    "LighthouseMetaDto",
+    "LighthouseResponseDto",
+    "LoadTimeDataDto",
+    "LoadTimeDto",
+    "LoadTimeMetaDto",
+    "LoadTimeResponseDto",
+    "MarginDto",
+    "MetaScrapeDto",
+    "MetaScrapeMetaDto",
+    "MetaScrapeResponseDto",
+    "MetaScrapeResponseDtoData",
+    "MixedContentDataDto",
+    "MixedContentDto",
+    "MixedContentMetaDto",
+    "MixedContentResponseDto",
+    "MixedContentResponseDtoData",
+    "MtrDataDto",
+    "MtrDto",
+    "MtrMetaDto",
+    "MtrResponseDto",
+    "NetworkDto",
+    "OpenPortDto",
+    "OpenPortMetaDto",
+    "OpenPortResponseDto",
+    "PingDataDto",
+    "PingDto",
+    "PingMetaDto",
+    "PingResponseDto",
+    "ProtocolSupportDto",
+    "RedirectCheckDto",
+    "RedirectCheckMetaDto",
+    "RedirectCheckResponseDto",
+    "RedirectHopDto",
+    "ScreenshotDto",
+    "ScreenshotMetaDto",
+    "ScreenshotResponseDto",
+    "Search200Response",
+    "SearchHtmlResponseDto",
+    "SearchMarkdownResponseDto",
+    "SearchMetaDto",
+    "SearchRequestDto",
+    "SearchResponseDto",
+    "SearchResultItemDto",
+    "SelectorExtractionFieldDto",
+    "ServiceHealthResponseDto",
+    "ServiceStatus",
+    "SiteStatusDto",
+    "SiteStatusMetaDto",
+    "SiteStatusResponseDto",
+    "TestMetaDto",
+    "TimingsDto",
+    "TlsCertificateDto",
+    "TlsCertificateIssuerDto",
+    "TlsProtocolsDto",
+    "TlsScanDataDto",
+    "TlsScanDto",
+    "TlsScanMetaDto",
+    "TlsScanResponseDto",
+    "Url2PdfDto",
+    "Url2PdfMetaDto",
+    "Url2PdfResponseDto",
+    "WebScrapeDto",
+    "WebScrapeMetaDto",
+    "WebScrapeResponseDto",
+]
+
+# import apis into sdk package
+from geekflare_api.api.api_tool_api import ApiToolApi as ApiToolApi
+
+# import ApiClient
+from geekflare_api.api_response import ApiResponse as ApiResponse
+from geekflare_api.api_client import ApiClient as ApiClient
+from geekflare_api.configuration import Configuration as Configuration
+from geekflare_api.exceptions import OpenApiException as OpenApiException
+from geekflare_api.exceptions import ApiTypeError as ApiTypeError
+from geekflare_api.exceptions import ApiValueError as ApiValueError
+from geekflare_api.exceptions import ApiKeyError as ApiKeyError
+from geekflare_api.exceptions import ApiAttributeError as ApiAttributeError
+from geekflare_api.exceptions import ApiException as ApiException
+
+# import models into sdk package
+from geekflare_api.models.base_error_response_dto import BaseErrorResponseDto as BaseErrorResponseDto
+from geekflare_api.models.broken_link_dto import BrokenLinkDto as BrokenLinkDto
+from geekflare_api.models.broken_link_meta_dto import BrokenLinkMetaDto as BrokenLinkMetaDto
+from geekflare_api.models.broken_link_response_dto import BrokenLinkResponseDto as BrokenLinkResponseDto
+from geekflare_api.models.broken_link_summary_dto import BrokenLinkSummaryDto as BrokenLinkSummaryDto
+from geekflare_api.models.default_extraction_field_dto import DefaultExtractionFieldDto as DefaultExtractionFieldDto
+from geekflare_api.models.dns_meta_dto import DnsMetaDto as DnsMetaDto
+from geekflare_api.models.dns_record_dto import DnsRecordDto as DnsRecordDto
+from geekflare_api.models.dns_record_response_dto import DnsRecordResponseDto as DnsRecordResponseDto
+from geekflare_api.models.dns_sec_data_dto import DnsSecDataDto as DnsSecDataDto
+from geekflare_api.models.dns_sec_dto import DnsSecDto as DnsSecDto
+from geekflare_api.models.dns_sec_meta_dto import DnsSecMetaDto as DnsSecMetaDto
+from geekflare_api.models.dns_sec_response_dto import DnsSecResponseDto as DnsSecResponseDto
+from geekflare_api.models.extraction_schema_dto import ExtractionSchemaDto as ExtractionSchemaDto
+from geekflare_api.models.extraction_schema_dto_fields_inner import ExtractionSchemaDtoFieldsInner as ExtractionSchemaDtoFieldsInner
+from geekflare_api.models.health_response_dto import HealthResponseDto as HealthResponseDto
+from geekflare_api.models.image_search_response_dto import ImageSearchResponseDto as ImageSearchResponseDto
+from geekflare_api.models.image_search_result_item_dto import ImageSearchResultItemDto as ImageSearchResultItemDto
+from geekflare_api.models.lighthouse_dto import LighthouseDto as LighthouseDto
+from geekflare_api.models.lighthouse_meta_dto import LighthouseMetaDto as LighthouseMetaDto
+from geekflare_api.models.lighthouse_response_dto import LighthouseResponseDto as LighthouseResponseDto
+from geekflare_api.models.load_time_data_dto import LoadTimeDataDto as LoadTimeDataDto
+from geekflare_api.models.load_time_dto import LoadTimeDto as LoadTimeDto
+from geekflare_api.models.load_time_meta_dto import LoadTimeMetaDto as LoadTimeMetaDto
+from geekflare_api.models.load_time_response_dto import LoadTimeResponseDto as LoadTimeResponseDto
+from geekflare_api.models.margin_dto import MarginDto as MarginDto
+from geekflare_api.models.meta_scrape_dto import MetaScrapeDto as MetaScrapeDto
+from geekflare_api.models.meta_scrape_meta_dto import MetaScrapeMetaDto as MetaScrapeMetaDto
+from geekflare_api.models.meta_scrape_response_dto import MetaScrapeResponseDto as MetaScrapeResponseDto
+from geekflare_api.models.meta_scrape_response_dto_data import MetaScrapeResponseDtoData as MetaScrapeResponseDtoData
+from geekflare_api.models.mixed_content_data_dto import MixedContentDataDto as MixedContentDataDto
+from geekflare_api.models.mixed_content_dto import MixedContentDto as MixedContentDto
+from geekflare_api.models.mixed_content_meta_dto import MixedContentMetaDto as MixedContentMetaDto
+from geekflare_api.models.mixed_content_response_dto import MixedContentResponseDto as MixedContentResponseDto
+from geekflare_api.models.mixed_content_response_dto_data import MixedContentResponseDtoData as MixedContentResponseDtoData
+from geekflare_api.models.mtr_data_dto import MtrDataDto as MtrDataDto
+from geekflare_api.models.mtr_dto import MtrDto as MtrDto
+from geekflare_api.models.mtr_meta_dto import MtrMetaDto as MtrMetaDto
+from geekflare_api.models.mtr_response_dto import MtrResponseDto as MtrResponseDto
+from geekflare_api.models.network_dto import NetworkDto as NetworkDto
+from geekflare_api.models.open_port_dto import OpenPortDto as OpenPortDto
+from geekflare_api.models.open_port_meta_dto import OpenPortMetaDto as OpenPortMetaDto
+from geekflare_api.models.open_port_response_dto import OpenPortResponseDto as OpenPortResponseDto
+from geekflare_api.models.ping_data_dto import PingDataDto as PingDataDto
+from geekflare_api.models.ping_dto import PingDto as PingDto
+from geekflare_api.models.ping_meta_dto import PingMetaDto as PingMetaDto
+from geekflare_api.models.ping_response_dto import PingResponseDto as PingResponseDto
+from geekflare_api.models.protocol_support_dto import ProtocolSupportDto as ProtocolSupportDto
+from geekflare_api.models.redirect_check_dto import RedirectCheckDto as RedirectCheckDto
+from geekflare_api.models.redirect_check_meta_dto import RedirectCheckMetaDto as RedirectCheckMetaDto
+from geekflare_api.models.redirect_check_response_dto import RedirectCheckResponseDto as RedirectCheckResponseDto
+from geekflare_api.models.redirect_hop_dto import RedirectHopDto as RedirectHopDto
+from geekflare_api.models.screenshot_dto import ScreenshotDto as ScreenshotDto
+from geekflare_api.models.screenshot_meta_dto import ScreenshotMetaDto as ScreenshotMetaDto
+from geekflare_api.models.screenshot_response_dto import ScreenshotResponseDto as ScreenshotResponseDto
+from geekflare_api.models.search200_response import Search200Response as Search200Response
+from geekflare_api.models.search_html_response_dto import SearchHtmlResponseDto as SearchHtmlResponseDto
+from geekflare_api.models.search_markdown_response_dto import SearchMarkdownResponseDto as SearchMarkdownResponseDto
+from geekflare_api.models.search_meta_dto import SearchMetaDto as SearchMetaDto
+from geekflare_api.models.search_request_dto import SearchRequestDto as SearchRequestDto
+from geekflare_api.models.search_response_dto import SearchResponseDto as SearchResponseDto
+from geekflare_api.models.search_result_item_dto import SearchResultItemDto as SearchResultItemDto
+from geekflare_api.models.selector_extraction_field_dto import SelectorExtractionFieldDto as SelectorExtractionFieldDto
+from geekflare_api.models.service_health_response_dto import ServiceHealthResponseDto as ServiceHealthResponseDto
+from geekflare_api.models.service_status import ServiceStatus as ServiceStatus
+from geekflare_api.models.site_status_dto import SiteStatusDto as SiteStatusDto
+from geekflare_api.models.site_status_meta_dto import SiteStatusMetaDto as SiteStatusMetaDto
+from geekflare_api.models.site_status_response_dto import SiteStatusResponseDto as SiteStatusResponseDto
+from geekflare_api.models.test_meta_dto import TestMetaDto as TestMetaDto
+from geekflare_api.models.timings_dto import TimingsDto as TimingsDto
+from geekflare_api.models.tls_certificate_dto import TlsCertificateDto as TlsCertificateDto
+from geekflare_api.models.tls_certificate_issuer_dto import TlsCertificateIssuerDto as TlsCertificateIssuerDto
+from geekflare_api.models.tls_protocols_dto import TlsProtocolsDto as TlsProtocolsDto
+from geekflare_api.models.tls_scan_data_dto import TlsScanDataDto as TlsScanDataDto
+from geekflare_api.models.tls_scan_dto import TlsScanDto as TlsScanDto
+from geekflare_api.models.tls_scan_meta_dto import TlsScanMetaDto as TlsScanMetaDto
+from geekflare_api.models.tls_scan_response_dto import TlsScanResponseDto as TlsScanResponseDto
+from geekflare_api.models.url2_pdf_dto import Url2PdfDto as Url2PdfDto
+from geekflare_api.models.url2_pdf_meta_dto import Url2PdfMetaDto as Url2PdfMetaDto
+from geekflare_api.models.url2_pdf_response_dto import Url2PdfResponseDto as Url2PdfResponseDto
+from geekflare_api.models.web_scrape_dto import WebScrapeDto as WebScrapeDto
+from geekflare_api.models.web_scrape_meta_dto import WebScrapeMetaDto as WebScrapeMetaDto
+from geekflare_api.models.web_scrape_response_dto import WebScrapeResponseDto as WebScrapeResponseDto
+from geekflare_api.client import GeekflareClient
+

geekflare_api-0.1.0/geekflare_api/api/__init__.py

@@ -0,0 +1,5 @@
+# flake8: noqa
+
+# import apis into api package
+from geekflare_api.api.api_tool_api import ApiToolApi
+