> built 2026-09-22 15:07 UTC from ebb6f7f (master) · pchealthstream2py 0.1.6. Details: build_info.json

# index.html.md

<!-- generated by epythet -->

# pchealthstream2py

stream2py interface to pc health

To install:	`pip install pchealthstream2py`

<p class="epythet-aggregates">This documentation as a single file: <a href="pchealthstream2py.md">pchealthstream2py.md</a> (Markdown, for agents).</p>


# _autosummary/pchealthstream2py.html.md

# pchealthstream2py

Getting streams of PC stats

### Modules

| [`pchealth`](_autosummary/pchealthstream2py.pchealth.html.md#module-pchealthstream2py.pchealth)   | Provide computer status info.   |
|-----------------------------------------------------------------------------------------------|---------------------------------|


# _autosummary/pchealthstream2py.pchealth.html.md

# pchealthstream2py.pchealth

Provide computer status info.

To get network upload and download speeds, speedtest-cli app should be installed

### Classes

| `StatusInfo`()                                                                             |    |
|--------------------------------------------------------------------------------------------|----|
| [`StatusInfoReader`](_autosummary/pchealthstream2py.pchealth.html.md#pchealthstream2py.pchealth.StatusInfoReader)([read_interval_ms, ...]) |    |

### *class* pchealthstream2py.pchealth.StatusInfoReader(read_interval_ms=1000, include_network_download_speed=False, include_network_upload_speed=False, , reopen_timeout_s=None)

Bases: `SourceReader`, [`Thread`](https://docs.python.org/3/library/threading.html#threading.Thread)

#### close()

Close and clean up source reader.
Will be called when StreamBuffer stops or if an exception is raised during read and append
loop.

#### *property* info *: [dict](https://docs.python.org/3/builtins/stdtypes.html#dict)*

A dict with important source info. Default can be init_kwargs and open timestamp.

This info will be available in BufferReader after SourceReader has opened but any changes
made between open and close are not guaranteed to be visible. Any continuous status updates
should be included with read data instead.

* **Returns:**
  dict

#### is_alive()

Whether the reader is currently reading, whichever thread is doing it.

The work runs in a per-`open()` worker thread (see `_start_worker`), not
in `self`, so the inherited `Thread.is_alive` would describe the wrong
thread. (A reader started the legacy way, with `start()` rather than
`open()`, has no worker and answers for `self` as before.)

* **Return type:**
  [`bool`](https://docs.python.org/3/builtins/functions.html#bool)

#### join(timeout=None)

Wait for the current run’s worker thread to finish (see `is_alive`).

* **Return type:**
  [`None`](https://docs.python.org/3/builtins/constants.html#None)

#### key(data)

* **Parameters:**
  **data** ([`Any`](https://docs.python.org/3/library/typing.html#typing.Any)) – (index, timestamp, character)
* **Return type:**
  `ComparableType`
* **Returns:**
  index

#### open()

Start reading status info in the background.

Can be called again after `close()`: a reader is reusable, as
`SourceReader`’s reuse contract requires. Each call stops and waits for
the worker started by the previous call, so exactly one thread feeds
the queue at a time.

#### read()

Returns one data item

* **Returns:**
  (index, timestamp, character)

#### run()

Method representing the thread’s activity.

You may override this method in a subclass. The standard run() method
invokes the callable object passed to the object’s constructor as the
target argument, if any, with sequential and keyword arguments taken
from the args and kwargs arguments, respectively.


# about-this-build.html.md

<!-- generated by epythet -->

# About this build

This documentation was built on **2026-09-22 15:07 UTC** from commit <a href="https://github.com/i2mint/pchealthstream2py/commit/ebb6f7f3258b0a6523f1d4fbdd332913b208a67a"><code>ebb6f7f</code></a> on branch <code>master</code>, for **pchealthstream2py 0.1.6** (from <code>pyproject.toml</code>).

#### WARNING
The documentation and the package may be misaligned:

- The documented version (0.1.6) is behind the latest release on PyPI (0.1.7): `pip install pchealthstream2py` gives newer code than these docs describe.

## Source

|                     |                                                                                                                                                                 |
|---------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Commit              | <a href="https://github.com/i2mint/pchealthstream2py/commit/ebb6f7f3258b0a6523f1d4fbdd332913b208a67a"><code>ebb6f7f3258b0a6523f1d4fbdd332913b208a67a</code></a> |
| Branch              | <code>master</code>                                                                                                                                             |
| Tags at this commit | none                                                                                                                                                            |
| Working tree        | clean                                                                                                                                                           |
| Remote              | <code>https://github.com/i2mint/pchealthstream2py</code>                                                                                                        |

## Continuous integration

|              |                                                                                                |
|--------------|------------------------------------------------------------------------------------------------|
| Repository   | <code>i2mint/pchealthstream2py</code>                                                          |
| Run          | <a href="https://github.com/i2mint/pchealthstream2py/actions/runs/35744921592">35744921592</a> |
| Ref          | <code>refs/heads/master</code>                                                                 |
| Event commit | <code>ebb6f7f3258b0a6523f1d4fbdd332913b208a67a</code> (in the history of the built commit)     |

## Tools

|          |         |
|----------|---------|
| epythet  | 0.2.12  |
| Sphinx   | 9.1.0   |
| docutils | 0.22.4  |
| Python   | 3.12.14 |

## Configuration as resolved

|               |                                                                   |
|---------------|-------------------------------------------------------------------|
| theme         | <code>auto</code> (Sphinx theme <code>sphinxawesome_theme</code>) |
| accent        | <code>#3752a0</code>                                              |
| api_generator | <code>autosummary</code>                                          |
| ignore        | <code>tests/</code>, <code>scrap/</code>, <code>examples/</code>  |
| agent_outputs | <code>true</code>                                                 |
| aggregates    | <code>md</code>                                                   |
| ai_artifacts  | <code>true</code>                                                 |

## Package on PyPI

Latest release: <a href="https://pypi.org/project/pchealthstream2py/0.1.7/">0.1.7</a>, newer than the documented version (0.1.6).

## Reproduce

```bash
git clone https://github.com/i2mint/pchealthstream2py && cd pchealthstream2py
git checkout ebb6f7f3258b0a6523f1d4fbdd332913b208a67a
pip install "epythet==0.2.12"
epythet quickstart . --ignore tests/ scrap/ examples/
```

The same data, for machines: <a href="build_info.json"><code>build_info.json</code></a> (schema version 1).


# api.html.md

# API reference

| [`pchealthstream2py`](_autosummary/pchealthstream2py.html.md#module-pchealthstream2py)   | Getting streams of PC stats   |
|-----------------------------------------------------------------------------------------------|-------------------------------|