Skip to main content

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

Project description

https://travis-ci.org/parkerhancock/patent_client.svg?branch=master https://codecov.io/gh/parkerhancock/patent_client/branch/master/graph/badge.svg PyPI Package latest release PyPI Wheel Supported versions

Overview

A set of Django-ORM-Style accessors to publicly available intellectual property data.

Currently supports:

  • 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.

Documentation

The easiest way to get started is with Patent Client Examples. The examples repository has a list of Jupyter notebooks showing application examples of the patent_client library.

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

SUPER QUICK START

To use the project:

# Import the model classes you need
>>> from patent_client import Inpadoc, Epo, 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)
23860
>>> assignments[0].id
'47086-788'
>>> assignments[0].conveyance_text
'ASSIGNMENT OF ASSIGNORS INTEREST (SEE DOCUMENT FOR DETAILS).'

# Fetch from INPADOC
>>> pub = Inpadoc.objects.get('EP3082535A1')
>>> pub.title
'AUTOMATIC FLUID DISPENSER'
>>> pub.priority_claims
['201314137130', '2014071849']

# Fetch from EPO Register
>>> epo = Epo.objects.get('EP3082535A1')
>>> epo.title
'AUTOMATIC FLUID DISPENSER'
>>> epo.status
[{'description': 'Examination is in progress', 'code': '14', 'date': '20180615'}]

Other Languages

Merely as a way to explore other languages and technologies, I have built a few (partial) ports of this library to other languages:

Development

To run the all tests run:

pytest

A developer guide is provided in the Documentation. This project is narrowly scoped to only public documented API’s available without charge (at least for moderate usage). Scrapers of HTML websites are not permitted. But PR’s to add support for new API’s are more than welcome.

Pull requests welcome!

Changelog

2.0.1 (2020-03-12)

  • Fixed problem where Inpadoc was indexing improperly

2.0.0 (2020-03-11)

  • Major update with breaking API changes

  • Refactored all API’s to use requests_cache rather than custom caching scheme

  • Uses Marshmallow for data validation, and memory-efficient dataclasses for all objects

  • As part of the above, all API’s now re-use the same requests.Session() object

  • Deleted a ton of unnecessary code (Deleted code == debugged code)

  • NOTE: Documentation not yet up-to-date. That is the next project

0.4.0 (2019-01-30)

  • Renewed commitment to adhere to semantic versioning

  • Added several new synthetic data attributes, including expiration date calculations

  • General updates and improvements, including an overhaul of the base Manager and Model classes

0.2.3 (2018-11-02)

  • Added parser for Inpadoc claims so they have an object repesentation

0.1.5 (2018-10-25)

  • Massive refactor of OPS client

0.1.4 (2018-10-24)

  • Support for USPTO Applications, Assignments, and PTAB documents

  • Support for EPO Inpadoc and EPO Register

  • Initial Installation and Getting Started Documentation

0.0.1 (2018-10-15)

  • First release on PyPI.

  • Support for EPO OPS (except Classification data)

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-2.0.1.tar.gz (59.5 kB view details)

Uploaded Source

Built Distribution

patent_client-2.0.1-py2.py3-none-any.whl (50.8 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

  • Download URL: patent_client-2.0.1.tar.gz
  • Upload date:
  • Size: 59.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.0.0 requests-toolbelt/0.9.1 tqdm/4.43.0 CPython/3.7.1

File hashes

Hashes for patent_client-2.0.1.tar.gz
Algorithm Hash digest
SHA256 67020943ec4775bf5ac3511ddfa1c4194f18dec07bb5d0518f952e5cc882a9dc
MD5 b4d3d6e4bdfedca362f9842a96591bb5
BLAKE2b-256 819eade0abc1f5fe185dc313fb088aa96999031cda2d16a93b8482718d7d09d0

See more details on using hashes here.

File details

Details for the file patent_client-2.0.1-py2.py3-none-any.whl.

File metadata

  • Download URL: patent_client-2.0.1-py2.py3-none-any.whl
  • Upload date:
  • Size: 50.8 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.0.0 requests-toolbelt/0.9.1 tqdm/4.43.0 CPython/3.7.1

File hashes

Hashes for patent_client-2.0.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 be09c9c56b5bbe842d1c713172cf7811b3d88d2086a86eb58143ee3e7d54a062
MD5 cc4c34435392b8034dd818006f67453b
BLAKE2b-256 f16aa65202863e7ac623be396a36e8d33da90c2641c232b9cf6cc8a8ca30d848

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