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

Uploaded Source

Built Distribution

pcpartpicker-1.2.2-py3-none-any.whl (32.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: pcpartpicker-1.2.2.tar.gz
  • Upload date:
  • Size: 18.7 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.2.tar.gz
Algorithm Hash digest
SHA256 184a34468f348cca7169e894526bac61a6bd49cda3a5995675ef6a58de045c8e
MD5 5d022948b507287864d0445e6ca05a92
BLAKE2b-256 c29f86e2968e010da50e817d6f5aff0988074510ccb892dae77a5604de2af0ad

See more details on using hashes here.

File details

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

File metadata

  • Download URL: pcpartpicker-1.2.2-py3-none-any.whl
  • Upload date:
  • Size: 32.3 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.2-py3-none-any.whl
Algorithm Hash digest
SHA256 98439b9703728f0c6d759625d7214865648498dea04eff7f03bbe0de9e1d242c
MD5 21aac4c137b4fdb3320197b2fbdc86c0
BLAKE2b-256 689d8e9a469e6634e9c540eedf546ca5a86cfd7ae464e2648136a46b92df1b70

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