Skip to main content
Help us improve PyPI by participating in user testing. All experience levels needed!

pyspectator is a Python cross-platform tool for monitoring OS resources.

Project description

.. image:: https://badge.waffle.io/uzumaxy/pyspectator.png?label=ready&title=Ready
:target: https://waffle.io/uzumaxy/pyspectator
:alt: 'Stories in Ready'
=======
Summary
=======

pyspectator is a Python cross-platform tool for monitoring resources of OS: CPU, memory, disk, network.


============
Requirements
============

- OS: Linux, Windows, FreeBSD, Solaris
- Python version: 3.X
- Packages: psutil, netifaces, wmi (only on Windows), enum34 (only on python 3.0.0 - 3.4.0)

==============
How to install
==============

Run as root user:

.. code-block:: bash

pip install pyspectator



================
Example of usage
================

There is simple project named `pyspectator_tornado <https://github.com/uzumaxy/pyspectator_tornado>`_
developed special for demonstration of pyspectator features.

.. image:: http://i.imgur.com/yUjNlyQ.png
:target: http://i.imgur.com/LFMmfHu.png
:alt: General information

.. image:: http://i.imgur.com/omNJhno.png
:target: http://i.imgur.com/r0RuV2m.png
:alt: CPU

.. image:: http://i.imgur.com/qc3NwBa.png
:target: http://i.imgur.com/zA7mteS.png
:alt: Disk devices

.. image:: http://i.imgur.com/Dugsnr6.png
:target: http://i.imgur.com/rDadDzn.png
:alt: Network



==========
How to use
==========

You can use pyspectator as module for your own project. Simple example of usage is presented in file "console.py".

*NOTE: on Windows pyspectator can require elevated privileges.*

Class "Computer"
----------------

.. code-block:: python

>>> from pyspectator.computer import Computer
>>> computer = Computer()
>>> computer.os
'Linux 3.14.4-1-MANJARO'
>>> computer.python_version
'CPython ver. 3.4.1'
>>> computer.uptime
'1:07:52'
>>> computer.processor.name
'Intel(R) Core(TM) i3-3110M CPU @ 2.40GHz'


Class "Cpu"
-----------


.. code-block:: python

>>> from pyspectator.processor import Cpu
>>> from time import sleep
>>> cpu = Cpu(monitoring_latency=1)
>>> with cpu:
... for _ in range(8):
... cpu.load, cpu.temperature
... sleep(1.1)
...
(22.6, 55)
(6.1, 55)
(5.5, 54)
(7.1, 54)
(5.6, 54)
(7.0, 54)
(10.2, 54)
(6.6, 54)

Release history Release notifications

This version
History Node

1.2.1

History Node

1.1.2

History Node

1.1.0

History Node

1.0.8

History Node

1.0.7

History Node

1.0.6

History Node

1.0.5

History Node

1.0.4

History Node

1.0.3

History Node

1.0.2

History Node

1.0.1

History Node

1.0.0

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
pyspectator-1.2.1.tar.gz (12.5 kB) Copy SHA256 hash SHA256 Source None Dec 22, 2017

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page