Skip to main content

A fast, simple API for PCPartPicker.com.

Project description

pcpartpicker

Build Status Coverage Status

This is an unofficial Python 3.7+ API for the website pcpartpicker.com. It is written using asynchronous code and multiprocessing for efficient data retrieval. This package is currently in a stable beta.

Installation:

Package retrieval and installation can be easily accomplished through pip.

pip install pcpartpicker

Examples:

In order to use the API, simply import API from the pcpartpicker package.

from pcpartpicker import API

You can then instantiate the API class and use it to make requests.

api = API()
cpu_data = api.retrieve("cpu")
all_data = api.retrieve_all()

A list of supported parts can be obtained in the following manner:

api = API()
print(api.supported_parts)
>>> {'wireless-network-card', 'case-fan', 'cpu', 'cpu-cooler', 'headphones', 'motherboard', 'monitor', 'internal-hard-drive', 'external-hard-drive', 'ups', 'fan-controller', 'case', 'keyboard', 'mouse', 'wired-network-card', 'sound-card', 'video-card', 'speakers', 'optical-drive', 'power-supply', 'thermal-paste', 'memory'}

There are also a number of methods that can be used in order to customize the API behavior. For example, you can change the region, determine the number of concurrent, asynchronous connections that can be made, and can also set whether or not the API can use multiple threads.

Retrieving supported API regions:

api = API()
print(api.supported_regions)
>>> {'be', 'us', 'it', 'uk', 'ie', 'nz', 'de', 'ca', 'au', 'fr', 'se', 'es', 'in'}

Retrieving currently selected region (default is US):

api = API()
print(api.region)
>>> us

Creating an API object with a different default region:

api = API("de")
print(api.region)
>>> de

Changing the default region:

api = API()
api.set_region("de")
print(api.region)
>>> de

You can also configure whether or not the API is allowed to use multiple threads or not (default is True):

api = API()
api.set_multithreading(False)
print(api.multithreading)
>>> False

You can also use a keyword argument to configure this behavior:

api = API(multithreading=False)
print(api.multithreading)
>>> False

Project details


Download files

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

Source Distribution

pcpartpicker-2.1.0.tar.gz (9.7 kB view details)

Uploaded Source

Built Distribution

pcpartpicker-2.1.0-py3-none-any.whl (23.5 kB view details)

Uploaded Python 3

File details

Details for the file pcpartpicker-2.1.0.tar.gz.

File metadata

  • Download URL: pcpartpicker-2.1.0.tar.gz
  • Upload date:
  • Size: 9.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.15.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.36.0 CPython/3.7.1

File hashes

Hashes for pcpartpicker-2.1.0.tar.gz
Algorithm Hash digest
SHA256 aa24ed8232996a3ff4b902c2d331abbb647089147457fe26cbb1d6b6fd56b692
MD5 da184362fec86cffb9c4374a953a23a0
BLAKE2b-256 28a2e7cff34332532d1d5445b7d449e350e7409519eb30232c32480257a18161

See more details on using hashes here.

File details

Details for the file pcpartpicker-2.1.0-py3-none-any.whl.

File metadata

  • Download URL: pcpartpicker-2.1.0-py3-none-any.whl
  • Upload date:
  • Size: 23.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.15.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.36.0 CPython/3.7.1

File hashes

Hashes for pcpartpicker-2.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 744df984775cc11f8c562b07d0cbf851bc32415fc287aa17a3e45baffc1da80b
MD5 08b084127ea6b0853ae31757099c13b5
BLAKE2b-256 f047c3c8b2e2eef548cb9a4e69690cb409a6835cd65ba882cf4b7939a2eb1401

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