diff options
author | Giampaolo Rodola <g.rodola@gmail.com> | 2020-10-18 17:04:09 +0200 |
---|---|---|
committer | GitHub <noreply@github.com> | 2020-10-18 17:04:09 +0200 |
commit | e2c2ba79f3b23725c4af5e1406b0cd210c3af7a9 (patch) | |
tree | bdd868a41b51c93f1238b3d225d944830b9df42c | |
parent | 958f18638cfee77e441f29fd54ab0f8c3af084ed (diff) | |
download | psutil-e2c2ba79f3b23725c4af5e1406b0cd210c3af7a9.tar.gz |
Update README (#1854)
-rw-r--r-- | README.rst | 132 | ||||
-rw-r--r-- | docs/_static/psutil-logo.png | bin | 0 -> 7228 bytes | |||
-rw-r--r-- | docs/_static/tidelift-logo.png | bin | 0 -> 2271 bytes | |||
-rw-r--r-- | psutil/_common.py | 2 |
4 files changed, 66 insertions, 68 deletions
@@ -68,18 +68,21 @@ ----- -Quick links -=========== - -- `Home page <https://github.com/giampaolo/psutil>`_ -- `Install <https://github.com/giampaolo/psutil/blob/master/INSTALL.rst>`_ -- `Documentation <http://psutil.readthedocs.io>`_ -- `Download <https://pypi.org/project/psutil/#files>`_ -- `Forum <http://groups.google.com/group/psutil/topics>`_ -- `StackOverflow <https://stackoverflow.com/questions/tagged/psutil>`_ -- `Blog <https://gmpy.dev/tags/psutil>`_ -- `Development guide <https://github.com/giampaolo/psutil/blob/master/docs/DEVGUIDE.rst>`_ -- `What's new <https://github.com/giampaolo/psutil/blob/master/HISTORY.rst>`_ +.. raw:: html + + <div align="center"> + <a href="https://github.com/giampaolo/psutil"><img src="https://github.com/giampaolo/psutil/raw/master/docs/_static/psutil-logo.png" /></a> + <br /> + <br /> + <a href="https://github.com/giampaolo/psutil"><b>Home</b></a> + <a href="https://github.com/giampaolo/psutil/blob/master/INSTALL.rst"><b>Install</b></a> + <a href="https://psutil.readthedocs.io/"><b>Documentation</b></a> + <a href="https://pypi.org/project/psutil/#files"><b>Download</b></a> + <a href="http://groups.google.com/group/psutil/topics"><b>Forum</b></a> + <a href="https://gmpy.dev/tags/psutil"><b>Blog</b></a> + <a href="#funding"><b>Funding</b></a> + <a href="https://github.com/giampaolo/psutil/blob/master/HISTORY.rst"><b>What's new</b></a> + </div> Summary ======= @@ -102,68 +105,39 @@ psutil currently supports the following platforms: ...both **32-bit** and **64-bit** architectures. Supported Python versions are **2.6**, **2.7** and **3.4+**, `PyPy <http://pypy.org/>`__ 2.7 and 3.X. -psutil for enterprise -===================== - -.. |tideliftlogo| image:: https://nedbatchelder.com/pix/Tidelift_Logos_RGB_Tidelift_Shorthand_On-White_small.png - :width: 150 - :alt: Tidelift - :target: https://tidelift.com/subscription/pkg/pypi-psutil?utm_source=pypi-psutil&utm_medium=referral&utm_campaign=readme - -.. list-table:: - :widths: 10 150 - - * - |tideliftlogo| - - The maintainer of psutil and thousands of other packages are working - with Tidelift to deliver commercial support and maintenance for the open - source dependencies you use to build your applications. Save time, - reduce risk, and improve code health, while paying the maintainers of - the exact dependencies you use. - `Learn more <https://tidelift.com/subscription/pkg/pypi-psutil?utm_source=pypi-psutil&utm_medium=referral&utm_campaign=enterprise&utm_term=repo>`__. - - By subscribing to Tidelift you will help me (`Giampaolo Rodola`_) support - psutil future development. Alternatively consider making a small - `donation`_. +Funding +======= -Security +While psutil is free software and will always be, the project would benefit +immensely from some funding. +Keeping up with bug reports and maintenance has become hardly sustainable for +me alone in terms of time. +If you're a company that's making significant use of psutil you can consider +becoming a sponsor via `GitHub <https://github.com/sponsors/giampaolo>`__, +`Open Collective <https://opencollective.com/psutil>`__ or +`PayPal <https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=A9ZS7PKKRM3S8>`__ +and have your logo displayed in here and psutil `doc <https://psutil.readthedocs.io>`__. + +Sponsors ======== -To report a security vulnerability, please use the `Tidelift security -contact`_. Tidelift will coordinate the fix and disclosure. - -Sponsorship -=========== - -A lot of time and effort went into making psutil as it is today. If you whish -to help its future development consider -`sponsoring <https://github.com/sponsors/giampaolo>`__ it. - -Projects using psutil -===================== - -psutil has roughly the following monthly downloads: +.. raw:: html -.. image:: https://img.shields.io/pypi/dm/psutil.svg - :target: https://pepy.tech/project/psutil - :alt: Downloads + <div> + <a href="https://tidelift.com/subscription/pkg/pypi-psutil?utm_source=pypi-psutil&utm_medium=referral&utm_campaign=readme"> + <img src="https://github.com/giampaolo/psutil/raw/master/docs/_static/tidelift-logo.png" /> + </a> + </div> + <sup><a href="https://github.com/sponsors/giampaolo">add your logo</a></sup> -...and has over 55,000 projects on GitHub depending from it. -Here's some I find particularly interesting: +Supporters +========== -- https://github.com/google/grr -- https://github.com/facebook/osquery/ -- https://github.com/nicolargo/glances -- https://github.com/Jahaja/psdash -- https://github.com/ajenti/ajenti -- https://github.com/home-assistant/home-assistant/ +None yet. -Portings -======== +.. raw:: html -- Go: https://github.com/shirou/gopsutil -- C: https://github.com/hamon-in/cpslib -- Rust: https://github.com/rust-psutil/rust-psutil -- Nim: https://github.com/johnscillieri/psutil-nim + <sup><a href="https://github.com/sponsors/giampaolo">add your avatar</a></sup> Example usages ============== @@ -502,9 +476,33 @@ Windows services 'status': 'stopped', 'username': 'NT AUTHORITY\\LocalService'} +Projects using psutil +===================== + +Here's some I find particularly interesting: + +- https://github.com/google/grr +- https://github.com/facebook/osquery/ +- https://github.com/nicolargo/glances +- https://github.com/Jahaja/psdash +- https://github.com/ajenti/ajenti +- https://github.com/home-assistant/home-assistant/ + +Portings +======== + +- Go: https://github.com/shirou/gopsutil +- C: https://github.com/hamon-in/cpslib +- Rust: https://github.com/rust-psutil/rust-psutil +- Nim: https://github.com/johnscillieri/psutil-nim + +Security +======== + +To report a security vulnerability, please use the `Tidelift security +contact`_. Tidelift will coordinate the fix and disclosure. .. _`Giampaolo Rodola`: https://gmpy.dev/about .. _`donation`: https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=A9ZS7PKKRM3S8 .. _Tidelift security contact: https://tidelift.com/security .. _Tidelift Subscription: https://tidelift.com/subscription/pkg/pypi-psutil?utm_source=pypi-psutil&utm_medium=referral&utm_campaign=readme - diff --git a/docs/_static/psutil-logo.png b/docs/_static/psutil-logo.png Binary files differnew file mode 100644 index 00000000..e1c67233 --- /dev/null +++ b/docs/_static/psutil-logo.png diff --git a/docs/_static/tidelift-logo.png b/docs/_static/tidelift-logo.png Binary files differnew file mode 100644 index 00000000..9e33757f --- /dev/null +++ b/docs/_static/tidelift-logo.png diff --git a/psutil/_common.py b/psutil/_common.py index 39d03af4..5ead5d90 100644 --- a/psutil/_common.py +++ b/psutil/_common.py @@ -766,7 +766,7 @@ else: @memoize -def term_supports_colors(file=sys.stdout): +def term_supports_colors(file=sys.stdout): # pragma: no cover if os.name == 'nt': return True try: |