| Name | olyptik JSON |
| Version |
0.1.0
JSON |
| download |
| home_page | None |
| Summary | Official Python SDK for Olyptik API |
| upload_time | 2025-08-12 14:33:08 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | MIT |
| keywords |
sdk
crawler
olyptik
api
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Olyptik Python SDK
Official Python SDK for the Olyptik API - a powerful web crawling and data extraction service.
## Installation
```bash
pip install olyptik
```
## Quick Start
### Synchronous Usage
```python
from olyptik import Olyptik
# Initialize the client
client = Olyptik(api_key="your_api_key_here")
# Start a crawl
crawl = client.start_crawl({
"url": "https://example.com",
"limit": 10
})
print(f"Crawl started with ID: {crawl.id}")
# Get crawl results
results = client.get_crawl_results(crawl.id)
for result in results.data:
print(f"URL: {result.url}")
print(f"Title: {result.title}")
```
### Asynchronous Usage
```python
import asyncio
from olyptik import AsyncOlyptik
async def main():
# Initialize the async client
client = AsyncOlyptik(api_key="your_api_key_here")
# Start a crawl
crawl = await client.start_crawl({
"url": "https://example.com",
"limit": 10
})
print(f"Crawl started with ID: {crawl.id}")
# Get crawl results
results = await client.get_crawl_results(crawl.id)
for result in results.data:
print(f"URL: {result.url}")
print(f"Title: {result.title}")
asyncio.run(main())
```
## Features
- 🚀 Simple and intuitive API
- ⚡ Both synchronous and asynchronous support
- 🔄 Automatic retry logic
- 📝 Full type hints support
- 🛡️ Built-in error handling
## Requirements
- Python 3.8+
- httpx>=0.27.0
- python-dotenv>=1.0.1
- typing-extensions>=4.8.0
## Documentation
For detailed documentation and API reference, visit [https://docs.olyptik.io](https://docs.olyptik.io)
## Support
- 📧 Email: support@olyptik.io
- 🐛 Issues: [GitHub Issues](https://github.com/olyptik/olyptik/issues)
- 🌐 Website: [https://www.olyptik.io](https://www.olyptik.io)
## License
This project is licensed under the MIT License.
Raw data
{
"_id": null,
"home_page": null,
"name": "olyptik",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "sdk, crawler, olyptik, api",
"author": null,
"author_email": "Olyptik <support@olyptik.io>",
"download_url": "https://files.pythonhosted.org/packages/dc/45/b71f376011ce780666aeab490869db60fb89787215f6bf5adef184de521a/olyptik-0.1.0.tar.gz",
"platform": null,
"description": "# Olyptik Python SDK\r\n\r\nOfficial Python SDK for the Olyptik API - a powerful web crawling and data extraction service.\r\n\r\n## Installation\r\n\r\n```bash\r\npip install olyptik\r\n```\r\n\r\n## Quick Start\r\n\r\n### Synchronous Usage\r\n\r\n```python\r\nfrom olyptik import Olyptik\r\n\r\n# Initialize the client\r\nclient = Olyptik(api_key=\"your_api_key_here\")\r\n\r\n# Start a crawl\r\ncrawl = client.start_crawl({\r\n \"url\": \"https://example.com\",\r\n \"limit\": 10\r\n})\r\n\r\nprint(f\"Crawl started with ID: {crawl.id}\")\r\n\r\n# Get crawl results\r\nresults = client.get_crawl_results(crawl.id)\r\nfor result in results.data:\r\n print(f\"URL: {result.url}\")\r\n print(f\"Title: {result.title}\")\r\n```\r\n\r\n### Asynchronous Usage\r\n\r\n```python\r\nimport asyncio\r\nfrom olyptik import AsyncOlyptik\r\n\r\nasync def main():\r\n # Initialize the async client\r\n client = AsyncOlyptik(api_key=\"your_api_key_here\")\r\n \r\n # Start a crawl\r\n crawl = await client.start_crawl({\r\n \"url\": \"https://example.com\",\r\n \"limit\": 10\r\n })\r\n \r\n print(f\"Crawl started with ID: {crawl.id}\")\r\n \r\n # Get crawl results\r\n results = await client.get_crawl_results(crawl.id)\r\n for result in results.data:\r\n print(f\"URL: {result.url}\")\r\n print(f\"Title: {result.title}\")\r\n\r\nasyncio.run(main())\r\n```\r\n\r\n## Features\r\n\r\n- \ud83d\ude80 Simple and intuitive API\r\n- \u26a1 Both synchronous and asynchronous support\r\n- \ud83d\udd04 Automatic retry logic\r\n- \ud83d\udcdd Full type hints support\r\n- \ud83d\udee1\ufe0f Built-in error handling\r\n\r\n## Requirements\r\n\r\n- Python 3.8+\r\n- httpx>=0.27.0\r\n- python-dotenv>=1.0.1\r\n- typing-extensions>=4.8.0\r\n\r\n## Documentation\r\n\r\nFor detailed documentation and API reference, visit [https://docs.olyptik.io](https://docs.olyptik.io)\r\n\r\n## Support\r\n\r\n- \ud83d\udce7 Email: support@olyptik.io\r\n- \ud83d\udc1b Issues: [GitHub Issues](https://github.com/olyptik/olyptik/issues)\r\n- \ud83c\udf10 Website: [https://www.olyptik.io](https://www.olyptik.io)\r\n\r\n## License\r\n\r\nThis project is licensed under the MIT License.\r\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Official Python SDK for Olyptik API",
"version": "0.1.0",
"project_urls": {
"Homepage": "https://www.olyptik.io",
"Issues": "https://github.com/olyptik/olyptik/issues",
"Repository": "https://github.com/olyptik/olyptik"
},
"split_keywords": [
"sdk",
" crawler",
" olyptik",
" api"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "ea7ac8ec0b4e6b58e68c93087f695d0c760270547fedaf11ac2438c125597d20",
"md5": "af9957736e246dd4f8f108e695b8ebd7",
"sha256": "c3f173c9b7ff8c718994a427f2c9085ab391889d4a3909ea11129c8aea5f0f66"
},
"downloads": -1,
"filename": "olyptik-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "af9957736e246dd4f8f108e695b8ebd7",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 5315,
"upload_time": "2025-08-12T14:33:06",
"upload_time_iso_8601": "2025-08-12T14:33:06.950351Z",
"url": "https://files.pythonhosted.org/packages/ea/7a/c8ec0b4e6b58e68c93087f695d0c760270547fedaf11ac2438c125597d20/olyptik-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "dc45b71f376011ce780666aeab490869db60fb89787215f6bf5adef184de521a",
"md5": "f985e38ae793c31dca95ed9064caff77",
"sha256": "9d2a1ace0aa7f848659ef389770f8bb702798c52ae90fa01b6d44bccfdb1c305"
},
"downloads": -1,
"filename": "olyptik-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "f985e38ae793c31dca95ed9064caff77",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 4673,
"upload_time": "2025-08-12T14:33:08",
"upload_time_iso_8601": "2025-08-12T14:33:08.064438Z",
"url": "https://files.pythonhosted.org/packages/dc/45/b71f376011ce780666aeab490869db60fb89787215f6bf5adef184de521a/olyptik-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-08-12 14:33:08",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "olyptik",
"github_project": "olyptik",
"github_not_found": true,
"lcname": "olyptik"
}
