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

Uploaded Source

Built Distribution

pcpartpicker-1.1.1-py3-none-any.whl (35.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: pcpartpicker-1.1.1.tar.gz
  • Upload date:
  • Size: 19.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/40.8.0 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.7.2

File hashes

Hashes for pcpartpicker-1.1.1.tar.gz
Algorithm Hash digest
SHA256 68a334742a0a02c853ff24218a45cb9b16a2dbba65410ec30b93eb367ba24e45
MD5 fe3e293b11c5b1863cb8080da8879beb
BLAKE2b-256 855171398b28e85eb7814b967c04c9dec2efe8e9f91dd2cfbe67f95dad982166

See more details on using hashes here.

File details

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

File metadata

  • Download URL: pcpartpicker-1.1.1-py3-none-any.whl
  • Upload date:
  • Size: 35.0 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/40.8.0 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.7.2

File hashes

Hashes for pcpartpicker-1.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 b69e8bb894af47ac44f5f26b9b768914ef6a036ab6f512d021376b43cb5e7c44
MD5 757ab430ea22da3d9c21049647360f43
BLAKE2b-256 f631bfe5fe6c647bca12ab8a11349bb836e956080060a2f83875b72c04b1c774

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