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, 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'

# Fetch from EPO Register (NOTE: This is broken right now :( )
#>>> 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.2 (2020-04-13)

  • Added foreign priority support back to PEDS API
  • Revised and simplified documentation to match v.2, including using Sphinx Autodoc
  • Added doctest support to documentation to confirm examples still work
  • Added docstrings throughout
  • Labeled some broken things as broken

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


Download files

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

Files for patent-client, version 2.0.2
Filename, size File type Python version Upload date Hashes
Filename, size patent_client-2.0.2-py2.py3-none-any.whl (56.3 kB) File type Wheel Python version py2.py3 Upload date Hashes View
Filename, size patent_client-2.0.2.tar.gz (65.5 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page