# Patsnap Python SDK
> ⚠️ This is an **unofficial** Python SDK for Patsnap's APIs. This SDK is **NOT officially supported or endorsed** by Patsnap. Use at your own discretion and ensure compliance with Patsnap's terms of service.
A comprehensive Python SDK for accessing Patsnap's patent and innovation intelligence APIs with a clean, intuitive interface.
## 🚀 Installation
```bash
pip install patsnap-pythonSDK
```
## ⚡ Quick Start
```python
import patsnap_pythonSDK as patsnap
# Configure the SDK
patsnap.configure(
client_id="your_client_id",
client_secret="your_client_secret"
)
# Search for AI patents
results = patsnap.analytics.search.query_search(
query_text="TACD: artificial intelligence",
limit=10
)
print(f"Found {results.data.total_search_result_count:,} AI patents")
for patent in results.data.results[:3]:
print(f"- {patent.title}")
```
## 📊 Usage Examples
### Patent Search
```python
# Search by patent number
patent = patsnap.patents.search.by_number(patent_number="US10123456B2")
# Search by company
results = patsnap.patents.search.by_current_assignee(
assignee="Apple Inc.",
limit=50
)
# Semantic search
similar = patsnap.patents.search.by_semantic_text(
text="machine learning artificial intelligence neural networks",
limit=25
)
# Visual search with single image
visual_results = patsnap.patents.search.by_image(
url="https://example.com/patent_diagram.jpg",
patent_type="D", # Design patents
model=1, # Smart Recommendation
limit=50
)
# Multi-image comprehensive search
multi_results = patsnap.patents.search.by_multiple_images(
urls=[
"https://example.com/front_view.jpg",
"https://example.com/back_view.jpg",
"https://example.com/side_view.jpg"
],
patent_type="D",
model=1,
limit=75
)
```
### Analytics Operations
```python
# Get patent count
count = patsnap.analytics.search.count(
query_text="TACD: artificial intelligence"
)
# Execute analytics query
results = patsnap.analytics.search.query(
query_text="TACD: machine learning",
limit=100
)
# Get field statistics
stats = patsnap.analytics.search.filter(
query="TTL: blockchain",
field="ASSIGNEE",
limit=50
)
```
### Image Upload Workflow
```python
# Upload image and get public URL
upload_result = patsnap.patents.search.upload_image(
image="path/to/patent_diagram.jpg"
)
# Use uploaded image for search
search_results = patsnap.patents.search.by_image(
url=upload_result.url,
patent_type="U", # Utility patents
model=4, # Shape & color
limit=30
)
```
## 🛠️ CLI Interface
The SDK includes a powerful command-line interface for API exploration:
```bash
# Show all available namespaces and methods
patsnap help
# Get detailed help for specific operations
patsnap help patents.search
patsnap help analytics.search
# Explore method details
patsnap help patents.search.by_image
```
## 📚 Documentation
- [Quick Start Guide](docs/QUICK_START.md)
- [Contributing Guide](CONTRIBUTING.md)
- [Implementation Documentation](docs/implementation/)
- [CLI Usage Guide](docs/CLI_USAGE.md)
- [Patent Search Examples](examples/patents/)
- [Analytics Examples](examples/analytics/)
## 📋 Complete Endpoint Checklist
### 🔍 Patent Search Operations (`patsnap.patents.search`)
- ✅`by_number()` - [P069] Patent Number Search (requires higher subscription)
- ✅ `by_original_assignee()` - [P004] Original Applicant Search
- ✅ `by_current_assignee()` - [P005] Current Assignee Search
- 🔧 `by_defense_applicant()` - [P006] Defense Patent Search
- ✅ `by_similarity()` - [P007] Similar Patent Search
- ✅ `by_semantic_text()` - [P008] Semantic Search
- ✅ `upload_image()` - [P010] Image Upload
- 🔧 `by_image()` - [P060] Single Image Search
- 🔧 `by_multiple_images()` - [P061] Multiple Image Search
### 📊 Analytics Operations (`patsnap.analytics.search`)
- ✅ `query_count()` - [P001] Analytics Query Count
- ✅ `query_search()` - [P002] Analytics Query Search
- ✅ `query_filter()` - [P003] Analytics Query Filter
### 📄 Patent Data Operations (`patsnap.patents.data`) - *Planned*
- 🚧 `simple_biblio()` - [P011] Simple Biblio
- 🚧 `biblio()` - [P012] Full Biblio
- 🚧 `legal_status()` - [P013] Legal Status
- 🚧 `family()` - [P014] Patent Family
- 🚧 `cited_by()` - [P015] Cited By Patents
- 🚧 `citations()` - [P016] Patent Citations
- 🚧 `claims()` - [P018] Claims
- 🚧 `description()` - [P019] Description
- 🚧 `pdf()` - [P020] PDF Download
### 🧠 AI Operations (`patsnap.ai`) - *Planned*
- 🚧 `agent.create_weekly_brief()` - [AI63-1] Weekly Brief
- 🚧 `agent.create_monthly_brief()` - [AI63-2] Monthly Brief
- 🚧 `ocr.create_task()` - [AI60] OCR Recognition
- 🚧 `translation.translate()` - [AI61] AI Translation
- 🚧 `ner.drug_entities()` - [AI01] Drug NER
- 🚧 `analysis.technical_qa()` - [AI36-1] Technical Q&A
### 🏢 Company Analytics (`patsnap.analytics.companies`) - *Planned*
- 🚧 `word_cloud()` - [A101] Innovation Word Cloud
- 🚧 `strategy_radar()` - [A102] Portfolio Strategy Radar
- 🚧 `key_technologies()` - [A103] Key Technologies
- 🚧 `trends()` - [A104] Application Trends
- 🚧 `portfolio_overview()` - [A105] Portfolio Overview
### 💊 Drug & Life Sciences (`patsnap.drugs`) - *Planned*
- 🚧 `search.general()` - [B007] Drug Search
- 🚧 `search.core_patents()` - [B009] Core Patent Search
- 🚧 `search.literature()` - [B011] Literature Search
- 🚧 `search.clinical_trials()` - [B012] Clinical Trials
- 🚧 `data.basic_info()` - [B018] Drug Basic Info
**Legend:**
- ✅ **Working** - Tested and functional
- ⚠️ **Limited** - Requires higher API subscription
- 🔧 **Implemented** - Code complete, needs testing
- 🚧 **Planned** - Not yet implemented
*Total: 250+ endpoints planned | Current: 11 implemented |*
## 🔧 Requirements
- Python 3.8+
- Valid Patsnap API credentials
- Internet connection for API access
## ⚖️ License
MIT License - see [LICENSE](LICENSE) file for details.
## 🤝 Contributing
We welcome contributions! Please see our [Contributing Guide](CONTRIBUTING.md) for details on:
- Development setup and guidelines
- Code standards and testing requirements
- How to implement new endpoints
- Documentation and example requirements
## ⚠️ Important Notes
- **Unofficial SDK**: While the author works for Patsnap, this is not officially supported by Patsnap
- **API Compliance**: Ensure your usage complies with Patsnap's terms of service
- **Rate Limits**: Respect API rate limits and usage guidelines
- **Data Privacy**: Handle patent and proprietary data responsibly
- **Testing**: Always test thoroughly in development before production use
## 📞 Support & Community
- **Issues**: Report bugs and request features via GitHub Issues
- **Discussions**: Join community discussions for questions and ideas
- **Contributing**: See [CONTRIBUTING.md](CONTRIBUTING.md) for development guidelines
- **Examples**: Comprehensive examples available in the [examples/](examples/) directory
---
Raw data
{
"_id": null,
"home_page": null,
"name": "patsnap-pythonSDK",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "patsnap, patents, api, sdk, intellectual-property, innovation",
"author": null,
"author_email": "Frazer Kearl <fkearl@patsnap.com>",
"download_url": "https://files.pythonhosted.org/packages/5b/92/35b8ec27c4b8eacd7cd329be973f4b150653018758baec119dfcb5a4095e/patsnap_pythonsdk-0.1.1.tar.gz",
"platform": null,
"description": "# Patsnap Python SDK\n\n> \u26a0\ufe0f This is an **unofficial** Python SDK for Patsnap's APIs. This SDK is **NOT officially supported or endorsed** by Patsnap. Use at your own discretion and ensure compliance with Patsnap's terms of service.\n\nA comprehensive Python SDK for accessing Patsnap's patent and innovation intelligence APIs with a clean, intuitive interface.\n\n## \ud83d\ude80 Installation\n\n```bash\npip install patsnap-pythonSDK\n```\n\n## \u26a1 Quick Start\n\n```python\nimport patsnap_pythonSDK as patsnap\n\n# Configure the SDK\npatsnap.configure(\n client_id=\"your_client_id\",\n client_secret=\"your_client_secret\"\n)\n\n# Search for AI patents\nresults = patsnap.analytics.search.query_search(\n query_text=\"TACD: artificial intelligence\",\n limit=10\n)\n\nprint(f\"Found {results.data.total_search_result_count:,} AI patents\")\nfor patent in results.data.results[:3]:\n print(f\"- {patent.title}\")\n```\n\n\n\n## \ud83d\udcca Usage Examples\n\n### Patent Search\n```python\n# Search by patent number\npatent = patsnap.patents.search.by_number(patent_number=\"US10123456B2\")\n\n# Search by company\nresults = patsnap.patents.search.by_current_assignee(\n assignee=\"Apple Inc.\",\n limit=50\n)\n\n# Semantic search\nsimilar = patsnap.patents.search.by_semantic_text(\n text=\"machine learning artificial intelligence neural networks\",\n limit=25\n)\n\n# Visual search with single image\nvisual_results = patsnap.patents.search.by_image(\n url=\"https://example.com/patent_diagram.jpg\",\n patent_type=\"D\", # Design patents\n model=1, # Smart Recommendation\n limit=50\n)\n\n# Multi-image comprehensive search\nmulti_results = patsnap.patents.search.by_multiple_images(\n urls=[\n \"https://example.com/front_view.jpg\",\n \"https://example.com/back_view.jpg\",\n \"https://example.com/side_view.jpg\"\n ],\n patent_type=\"D\",\n model=1,\n limit=75\n)\n```\n\n### Analytics Operations\n```python\n# Get patent count\ncount = patsnap.analytics.search.count(\n query_text=\"TACD: artificial intelligence\"\n)\n\n# Execute analytics query\nresults = patsnap.analytics.search.query(\n query_text=\"TACD: machine learning\",\n limit=100\n)\n\n# Get field statistics\nstats = patsnap.analytics.search.filter(\n query=\"TTL: blockchain\",\n field=\"ASSIGNEE\",\n limit=50\n)\n```\n\n### Image Upload Workflow\n```python\n# Upload image and get public URL\nupload_result = patsnap.patents.search.upload_image(\n image=\"path/to/patent_diagram.jpg\"\n)\n\n# Use uploaded image for search\nsearch_results = patsnap.patents.search.by_image(\n url=upload_result.url,\n patent_type=\"U\", # Utility patents\n model=4, # Shape & color\n limit=30\n)\n```\n\n## \ud83d\udee0\ufe0f CLI Interface\n\nThe SDK includes a powerful command-line interface for API exploration:\n\n```bash\n# Show all available namespaces and methods\npatsnap help\n\n# Get detailed help for specific operations\npatsnap help patents.search\npatsnap help analytics.search\n\n# Explore method details\npatsnap help patents.search.by_image\n```\n\n## \ud83d\udcda Documentation\n\n- [Quick Start Guide](docs/QUICK_START.md)\n- [Contributing Guide](CONTRIBUTING.md)\n- [Implementation Documentation](docs/implementation/)\n- [CLI Usage Guide](docs/CLI_USAGE.md)\n- [Patent Search Examples](examples/patents/)\n- [Analytics Examples](examples/analytics/)\n\n## \ud83d\udccb Complete Endpoint Checklist\n\n### \ud83d\udd0d Patent Search Operations (`patsnap.patents.search`)\n- \u2705`by_number()` - [P069] Patent Number Search (requires higher subscription)\n- \u2705 `by_original_assignee()` - [P004] Original Applicant Search\n- \u2705 `by_current_assignee()` - [P005] Current Assignee Search \n- \ud83d\udd27 `by_defense_applicant()` - [P006] Defense Patent Search\n- \u2705 `by_similarity()` - [P007] Similar Patent Search\n- \u2705 `by_semantic_text()` - [P008] Semantic Search\n- \u2705 `upload_image()` - [P010] Image Upload\n- \ud83d\udd27 `by_image()` - [P060] Single Image Search\n- \ud83d\udd27 `by_multiple_images()` - [P061] Multiple Image Search\n\n### \ud83d\udcca Analytics Operations (`patsnap.analytics.search`)\n- \u2705 `query_count()` - [P001] Analytics Query Count\n- \u2705 `query_search()` - [P002] Analytics Query Search \n- \u2705 `query_filter()` - [P003] Analytics Query Filter\n\n### \ud83d\udcc4 Patent Data Operations (`patsnap.patents.data`) - *Planned*\n- \ud83d\udea7 `simple_biblio()` - [P011] Simple Biblio\n- \ud83d\udea7 `biblio()` - [P012] Full Biblio\n- \ud83d\udea7 `legal_status()` - [P013] Legal Status\n- \ud83d\udea7 `family()` - [P014] Patent Family\n- \ud83d\udea7 `cited_by()` - [P015] Cited By Patents\n- \ud83d\udea7 `citations()` - [P016] Patent Citations\n- \ud83d\udea7 `claims()` - [P018] Claims\n- \ud83d\udea7 `description()` - [P019] Description\n- \ud83d\udea7 `pdf()` - [P020] PDF Download\n\n### \ud83e\udde0 AI Operations (`patsnap.ai`) - *Planned*\n- \ud83d\udea7 `agent.create_weekly_brief()` - [AI63-1] Weekly Brief\n- \ud83d\udea7 `agent.create_monthly_brief()` - [AI63-2] Monthly Brief\n- \ud83d\udea7 `ocr.create_task()` - [AI60] OCR Recognition\n- \ud83d\udea7 `translation.translate()` - [AI61] AI Translation\n- \ud83d\udea7 `ner.drug_entities()` - [AI01] Drug NER\n- \ud83d\udea7 `analysis.technical_qa()` - [AI36-1] Technical Q&A\n\n### \ud83c\udfe2 Company Analytics (`patsnap.analytics.companies`) - *Planned*\n- \ud83d\udea7 `word_cloud()` - [A101] Innovation Word Cloud\n- \ud83d\udea7 `strategy_radar()` - [A102] Portfolio Strategy Radar\n- \ud83d\udea7 `key_technologies()` - [A103] Key Technologies\n- \ud83d\udea7 `trends()` - [A104] Application Trends\n- \ud83d\udea7 `portfolio_overview()` - [A105] Portfolio Overview\n\n### \ud83d\udc8a Drug & Life Sciences (`patsnap.drugs`) - *Planned*\n- \ud83d\udea7 `search.general()` - [B007] Drug Search\n- \ud83d\udea7 `search.core_patents()` - [B009] Core Patent Search\n- \ud83d\udea7 `search.literature()` - [B011] Literature Search\n- \ud83d\udea7 `search.clinical_trials()` - [B012] Clinical Trials\n- \ud83d\udea7 `data.basic_info()` - [B018] Drug Basic Info\n\n**Legend:**\n- \u2705 **Working** - Tested and functional\n- \u26a0\ufe0f **Limited** - Requires higher API subscription\n- \ud83d\udd27 **Implemented** - Code complete, needs testing\n- \ud83d\udea7 **Planned** - Not yet implemented\n\n*Total: 250+ endpoints planned | Current: 11 implemented |*\n\n## \ud83d\udd27 Requirements\n\n- Python 3.8+\n- Valid Patsnap API credentials\n- Internet connection for API access\n\n## \u2696\ufe0f License\n\nMIT License - see [LICENSE](LICENSE) file for details.\n\n## \ud83e\udd1d Contributing\n\nWe welcome contributions! Please see our [Contributing Guide](CONTRIBUTING.md) for details on:\n\n- Development setup and guidelines\n- Code standards and testing requirements\n- How to implement new endpoints\n- Documentation and example requirements\n\n## \u26a0\ufe0f Important Notes\n\n- **Unofficial SDK**: While the author works for Patsnap, this is not officially supported by Patsnap\n- **API Compliance**: Ensure your usage complies with Patsnap's terms of service\n- **Rate Limits**: Respect API rate limits and usage guidelines\n- **Data Privacy**: Handle patent and proprietary data responsibly\n- **Testing**: Always test thoroughly in development before production use\n\n## \ud83d\udcde Support & Community\n\n- **Issues**: Report bugs and request features via GitHub Issues\n- **Discussions**: Join community discussions for questions and ideas\n- **Contributing**: See [CONTRIBUTING.md](CONTRIBUTING.md) for development guidelines\n- **Examples**: Comprehensive examples available in the [examples/](examples/) directory\n\n---\n",
"bugtrack_url": null,
"license": null,
"summary": "Unofficial Python SDK for Patsnap's patent and innovation intelligence APIs",
"version": "0.1.1",
"project_urls": {
"Bug Reports": "https://github.com/zenos27/patsnap-pythonSDK/issues",
"Documentation": "https://github.com/zenos27/patsnap-pythonSDK/blob/main/README.md",
"Homepage": "https://github.com/zenos27/patsnap-pythonSDK",
"Source": "https://github.com/zenos27/patsnap-pythonSDK"
},
"split_keywords": [
"patsnap",
" patents",
" api",
" sdk",
" intellectual-property",
" innovation"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "0462298ddc5f760a5c7e7a1fca502d3abeda852ae27bbb257780a48825201bff",
"md5": "bca2b88861c097838763d379babe1700",
"sha256": "de77dff209d02284540833b6a942b45f86558b9d7b487c007cd0cc9ad2d2595a"
},
"downloads": -1,
"filename": "patsnap_pythonsdk-0.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "bca2b88861c097838763d379babe1700",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 38023,
"upload_time": "2025-08-27T12:24:06",
"upload_time_iso_8601": "2025-08-27T12:24:06.312377Z",
"url": "https://files.pythonhosted.org/packages/04/62/298ddc5f760a5c7e7a1fca502d3abeda852ae27bbb257780a48825201bff/patsnap_pythonsdk-0.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "5b9235b8ec27c4b8eacd7cd329be973f4b150653018758baec119dfcb5a4095e",
"md5": "5817eef7ac4f54b854fc0a1581586955",
"sha256": "576d7dd4edd02da4d4dda4f05cf8372a4a55b7d4b0d939da1962275b4d5c50a7"
},
"downloads": -1,
"filename": "patsnap_pythonsdk-0.1.1.tar.gz",
"has_sig": false,
"md5_digest": "5817eef7ac4f54b854fc0a1581586955",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 81268,
"upload_time": "2025-08-27T12:24:07",
"upload_time_iso_8601": "2025-08-27T12:24:07.478998Z",
"url": "https://files.pythonhosted.org/packages/5b/92/35b8ec27c4b8eacd7cd329be973f4b150653018758baec119dfcb5a4095e/patsnap_pythonsdk-0.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-08-27 12:24:07",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "zenos27",
"github_project": "patsnap-pythonSDK",
"github_not_found": true,
"lcname": "patsnap-pythonsdk"
}
JSON
