Skip to main content

A set of ORM-style clients for publicly available intellectual property data

Project description

patent_client_logo

Build codecov Documentation

PyPI PyPI - Python Versions PyPI - Downloads Pydantic v2

Summary

A powerful library for accessing intellectual property, featuring:

  • 🍰 Ease of use: All sources use a simple unified API inspired by Django-ORM.
  • 🐼 Pandas Integration: Results are easily castable to Pandas Dataframes and Series.
  • 🚀 Performance: Fetched data is retrieved using the httpx library with native HTTP/2 and asyncio support, and cached using the hishel library for super-fast queries, and yankee for data extraction.
  • 🌐 Async/Await Support: All API's (optionally!) support the async/await syntax.
  • 🔮 Pydantic v2 Support: All models retrieved are Pydantic v2 models with all the goodness that comes with them!

Docs, including a fulsome Getting Started and User Guide are available on Read the Docs. The Examples folder includes examples of using patent_client for many common IP tasks

Coverage

  • Free software: Apache Software License 2.0

Installation

pip install patent_client

If you only want access to USPTO resources, you're done! However, additional setup is necessary to access EPO Inpadoc and EPO Register resources. See the Docs.

Quick Start

To use the project:

# Import the model classes you need
>>> from patent_client import Inpadoc, Assignment, USApplication

# Fetch US Applications
>>> app = USApplication.objects.get('15710770')
>>> app.patent_title
'Camera Assembly with Concave-Shaped Front Face'

# Fetch from USPTO Assignments
>>> assignments = Assignment.objects.filter(assignee='Google')
>>> len(assignments) > 23000
True
>>> assignment = Assignment.objects.get('47086-788')
>>> assignment.conveyance_text
'ASSIGNMENT OF ASSIGNORS INTEREST'

# Fetch from INPADOC
>>> pub = Inpadoc.objects.get('EP3082535A1')
>>> pub.biblio.title
'AUTOMATIC FLUID DISPENSER'

Async Quick Start

To use the asyncio methods, simply use async with for iterators, and call any methods with a a prefix:

apps = list()
async for app in USApplication.objects.filter(first_named_applicant="Google"):
  apps.append(app)

app = await USApplication.objects.aget("16123456")

Documentation

Docs, including a fulsome Getting Started are available on Read the Docs.

Development

To run the all tests run:

pytest

A developer guide is provided in the Documentation. Pull requests welcome!

Related projects

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

patent_client-4.0.0.tar.gz (2.3 MB view details)

Uploaded Source

Built Distribution

patent_client-4.0.0-py3-none-any.whl (2.4 MB view details)

Uploaded Python 3

File details

Details for the file patent_client-4.0.0.tar.gz.

File metadata

  • Download URL: patent_client-4.0.0.tar.gz
  • Upload date:
  • Size: 2.3 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.5.1 CPython/3.11.4 Darwin/22.6.0

File hashes

Hashes for patent_client-4.0.0.tar.gz
Algorithm Hash digest
SHA256 e7ca027c67fc66fd16e9dfe6dc65389cb696996f34c030304feaa5eba6762116
MD5 c1655ed97d3a27f94ffd273d7b06b7f6
BLAKE2b-256 0c786edebc4f7b48955d55d17b5f384446486b1ffb8b78671dcddbdb1a734f44

See more details on using hashes here.

File details

Details for the file patent_client-4.0.0-py3-none-any.whl.

File metadata

  • Download URL: patent_client-4.0.0-py3-none-any.whl
  • Upload date:
  • Size: 2.4 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.5.1 CPython/3.11.4 Darwin/22.6.0

File hashes

Hashes for patent_client-4.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 3df03c705e19dbd222be79b36540f4fd730def297e6fb3fb2a521533dfba6f09
MD5 8093997abed239ae6ceb3f5299b0235c
BLAKE2b-256 5454d0c9fb7a944a70398d01663b052c59ec85fd36057d41644d56b3811647a2

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page