.. _quickstart:

Quickstart
==========

Prerequisites
-------------
- Python 3.9 or newer.
- On macOS, `pyobjc` is required; it is installed automatically as a dependency.

Install
-------
Currently, the project is hosted on TestPyPI. To install, run:

.. code-block:: bash

   pip3 install --index-url https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple/ PySysInfo

The official PyPI release is:

.. image:: https://i.redd.it/ssjo8ocxehjb1.png
    :alt: Cyberpunk 2077 - Coming when it's ready

Basic usage
-----------
Instantiate the platform-aware manager and collect everything in one shot:

.. code-block:: python

   from pysysinfo import HardwareManager

   manager = HardwareManager()
   hardware = manager.fetch_hardware_info()
   print(hardware.model_dump_json(indent=2))

For the list of components supported, refer to :ref:`supported`.

Targeted collection
-------------------
Fetch individual components when you only need one subsystem:

.. code-block:: python

   from pysysinfo import HardwareManager

   manager = HardwareManager()

   cpu = manager.fetch_cpu_info()
   memory = manager.fetch_memory_info()
   storage = manager.fetch_storage_info()
   graphics = manager.fetch_graphics_info()



==========

Next Section: :ref:`hardware-managers`.