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

Changing the maximum number of allowed concurrent requests:

api = API()
api.set_concurrent_connections(100)
print(api.concurrent_connections)
>>> 100 

Or you can use the concurrent_connections keyword argument for API():

api = API(concurrent_connections=100)
print(api.concurrent_connections)
>>> 100

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

Uploaded Source

Built Distribution

pcpartpicker-1.2.3-py3-none-any.whl (32.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: pcpartpicker-1.2.3.tar.gz
  • Upload date:
  • Size: 18.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.7.3

File hashes

Hashes for pcpartpicker-1.2.3.tar.gz
Algorithm Hash digest
SHA256 65471555311c2fef8500065702f743a3945ad4656d1d95e4c66695ed9418bd09
MD5 9424a6a5ba3727cfb260d8cd80dfb5bc
BLAKE2b-256 663ca24f7a084ef149b6e4a6f21774fa2816e0231a30769602f72edcfc120c6e

See more details on using hashes here.

File details

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

File metadata

  • Download URL: pcpartpicker-1.2.3-py3-none-any.whl
  • Upload date:
  • Size: 32.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.7.3

File hashes

Hashes for pcpartpicker-1.2.3-py3-none-any.whl
Algorithm Hash digest
SHA256 20acc9983846f4b74f1a494b310a3b603909a4a54fcbfd850f020d41d47e28b5
MD5 329dcd5180eeba30fcb8622d0bfaeed8
BLAKE2b-256 fa0d0d4974d7e32bf8a61eec743a91e277245da823dd0abd6c940b9cd833dbe0

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