Skip to content

Commit

Permalink
Update and rename README.rst to README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
fabaff authored Jan 17, 2025
1 parent d38243a commit c4a5f94
Showing 1 changed file with 12 additions and 13 deletions.
25 changes: 12 additions & 13 deletions README.rst → README.md
Original file line number Diff line number Diff line change
@@ -1,32 +1,31 @@
python-glances-api
==================

A Python client for interacting with `Glances <https://nicolargo.github.io/glances/>`_.
A Python client for interacting with [Glances](https://nicolargo.github.io/glances/).

This module is not official, developed, supported or endorsed by Glances.

Installation
------------

The module is available from the `Python Package Index <https://pypi.python.org/pypi>`_.
The module is available from the [Python Package Index](https://pypi.python.org/pypi).

.. code:: bash
$ pip3 install glances_api
```bash
$ pip3 install glances_api
```

Or on a Fedora-based system or on a CentOS/RHEL machine with has EPEL enabled.

.. code:: bash
$ sudo dnf -y install python3-glances-api
```bash
$ sudo dnf -y install python3-glances-api
```

For Nix or NixOS is `pre-packed module <https://search.nixos.org/packages?channel=unstable&query=glances-api>`_
For Nix or NixOS is[ pre-packed module](https://search.nixos.org/packages?channel=unstable&query=glances-api)
available. The lastest release is usually present in the ``unstable`` channel.

.. code:: bash
$ nix-env -iA nixos.python3Packages.glances-api
```bash
$ nix-env -iA nixos.python3Packages.glances-api
```

Usage
-----
Expand Down

0 comments on commit c4a5f94

Please sign in to comment.