fr


Namefr JSON
Version 3.1 PyPI version JSON
download
home_pagehttps://github.com/mixmastamyk/fr
SummaryA program to print resources in delicious flavors.
upload_time2024-04-07 22:59:36
maintainerNone
docs_urlNone
authorMike Miller
requires_python>3.6.0
licenseGPLv3
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            
fr - Free Resource Printer
==========================

``fr`` is a command-line tool to print free resources in delicious
flavors.
In short,
``fr`` is to ``free`` as ``htop`` is to ``top``.

``fr`` was written due to unhappiness with the bare-bones, hard-to-read
``free`` command.
I wanted something a bit more… graphical.
Instead of this::

                 total       used       free     shared    buffers     cached
    Mem:       4045216    2159764    1885452          0     192404     942944
    -/+ buffers/cache:    1024416    3020800
    Swap:            0          0          0

You'll see something more like this::

    Free Resources in Blocks of 1 Megabyte (1,000,000 bytes)

    DEVICE   VOLUME    CAPACITY       USED       FREE                 MOUNT CACHE
    ⌁ RAM                 4,142      1,421      1,461  ▉▉▉▉▉▉▉░░░░░░▏       1,261
    ▪ SWAP                    0

    ▪ sda1   Ubuntu      18,617      7,000     10,671  ▉▉▉▉░░░░░░░░░▏ /
    ▪ sda5   Data        88,107     85,218      2,889  ▉▉▉▉▉▉▉▉▉▉▉▉░▏ /media/Data
    ◗ sr0    PREDATOR    45,206     45,206          0  ▉▉▉▉▉▉▉▉▉▉▉▉▉▏ /media/PREDATOR


... in fruity colors if you so choose.
Yes,
color can be turned off
(``NO_COLOR`` environment variable is supported),
units chosen,
network mounts filtered,
etc, etc.

``fr`` 3.x has been tested on
Ubuntu 18.04 Bionic "Tch-tch-tch-tch…",
Fedora 39,
Windows 7,
and
MacOS 10.13 "High Sierra,"
so far.


.. note::

    Version 3.x of ``fr`` has been ported and works only under Python 3.6 and
    over.
    To use with an earlier version of Python,
    try ``fr`` 1.x,
    which supports Python 2.7 and earlier platforms.


.. ~ .. raw:: html

   .. ~ <hr width=50 size=10>
   .. ~ <b>Works?</b>



Install
------------


Linux
~~~~~~~~~

As of ``fr`` version 3.x,
Dbus and Udisks are no longer required or used on Linux.
Rather,
data is read from the
``/proc``, ``/dev``, and potentially ``/sys``
filesystems.

To install per user (add ``/home/$USER/.local/bin`` to ``PATH``)::

    pip3 install --user fr

To install system-wide as root::

    sudo -H pip3 install fr


|

Windows
~~~~~~~~~

Support is still experimental.
Could use some help as Win7 in a VM is all I have access to these days.

To install per user::

    pip3 install --user fr[win]

(You'll need to add the install folder to your ``PATH``,
e.g. ``C:\Users\%USERNAME%\Python36\Scripts``.)

To install for everyone, run as Admin::

    pip3 install fr[win]    # installs winstats, colorama


|

Mac OS X
~~~~~~~~~

Yes, it supports that too.
Support is experimental as well::

    [sudo] pip3 install [--user] fr

And off you go.

FYI, the Unicode block characters look a bit better with Source Code Pro as the
terminal font—YMMV.

Could use some help here also,
borrowing a Mac is my only option.
Currently runs
``sysctl``, ``vm_stat``, and ``df`` under the hood,
hoping there are better options?


Limitations
~~~~~~~~~~~~~

Optical, Network, Removable
+++++++++++++++++++++++++++++

Both Windows and Mac OS are not currently able to detect whether extended
properties of filesystems.
The port to Python 3 seems to have broken Windows in that regard,
which used to work.

Unicode
+++++++++

I've given up on Unicode icons (for now) on the Windows console and went back
to ASCII.
Perhaps it should print out "conventional/high" memory too.

The Linux console (the real boot up console, pre-X) has a very limited
character set and therefore uses ASCII as well.

Colors
+++++++++

Both Windows and the Linux (non-X11) consoles are limited to sixteen colors.
Apparently Windows 10 has been upgraded to support more,
but I haven't yet found documentation on how to detect it.


Use
------------

Run it ;)

::

    fr

And of course there are a number of options,
spit out when this is typed::

    fr -h


.. note::

    Output will be in a compact format when the width of the
    terminal/console is under 90 characters.
    Give it more and it will expand to fill available space.


|

License
~~~~~~~~~

`GPL, version 3+ <http://www.gnu.org/licenses/gpl.html>`_.

|

Release Notes
~~~~~~~~~~~~~~~

- 3.01 - Fix locale.format on Python 3.12, skip devtmpfs by default on Linux.
- 3.00 - Major rewrite to support Python 3.6,
  refactor shitty thirteen year-old code,
  remove deps on Dbus and Udisks.
  Still needs a lot of work.

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/mixmastamyk/fr",
    "name": "fr",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">3.6.0",
    "maintainer_email": null,
    "keywords": null,
    "author": "Mike Miller",
    "author_email": null,
    "download_url": "https://files.pythonhosted.org/packages/e2/42/72f5957ce49de696510f87bea407592c13d274ebc4f98394fe6e4720a281/fr-3.1.tar.gz",
    "platform": null,
    "description": "\nfr - Free Resource Printer\n==========================\n\n``fr`` is a command-line tool to print free resources in delicious\nflavors.\nIn short,\n``fr`` is to ``free`` as ``htop`` is to ``top``.\n\n``fr`` was written due to unhappiness with the bare-bones, hard-to-read\n``free`` command.\nI wanted something a bit more\u2026 graphical.\nInstead of this::\n\n                 total       used       free     shared    buffers     cached\n    Mem:       4045216    2159764    1885452          0     192404     942944\n    -/+ buffers/cache:    1024416    3020800\n    Swap:            0          0          0\n\nYou'll see something more like this::\n\n    Free Resources in Blocks of 1 Megabyte (1,000,000 bytes)\n\n    DEVICE   VOLUME    CAPACITY       USED       FREE                 MOUNT CACHE\n    \u2301 RAM                 4,142      1,421      1,461  \u2589\u2589\u2589\u2589\u2589\u2589\u2589\u2591\u2591\u2591\u2591\u2591\u2591\u258f       1,261\n    \u25aa SWAP                    0\n\n    \u25aa sda1   Ubuntu      18,617      7,000     10,671  \u2589\u2589\u2589\u2589\u2591\u2591\u2591\u2591\u2591\u2591\u2591\u2591\u2591\u258f /\n    \u25aa sda5   Data        88,107     85,218      2,889  \u2589\u2589\u2589\u2589\u2589\u2589\u2589\u2589\u2589\u2589\u2589\u2589\u2591\u258f /media/Data\n    \u25d7 sr0    PREDATOR    45,206     45,206          0  \u2589\u2589\u2589\u2589\u2589\u2589\u2589\u2589\u2589\u2589\u2589\u2589\u2589\u258f /media/PREDATOR\n\n\n... in fruity colors if you so choose.\nYes,\ncolor can be turned off\n(``NO_COLOR`` environment variable is supported),\nunits chosen,\nnetwork mounts filtered,\netc, etc.\n\n``fr`` 3.x has been tested on\nUbuntu 18.04 Bionic \"Tch-tch-tch-tch\u2026\",\nFedora 39,\nWindows 7,\nand\nMacOS 10.13 \"High Sierra,\"\nso far.\n\n\n.. note::\n\n    Version 3.x of ``fr`` has been ported and works only under Python 3.6 and\n    over.\n    To use with an earlier version of Python,\n    try ``fr`` 1.x,\n    which supports Python 2.7 and earlier platforms.\n\n\n.. ~ .. raw:: html\n\n   .. ~ <hr width=50 size=10>\n   .. ~ <b>Works?</b>\n\n\n\nInstall\n------------\n\n\nLinux\n~~~~~~~~~\n\nAs of ``fr`` version 3.x,\nDbus and Udisks are no longer required or used on Linux.\nRather,\ndata is read from the\n``/proc``, ``/dev``, and potentially ``/sys``\nfilesystems.\n\nTo install per user (add ``/home/$USER/.local/bin`` to ``PATH``)::\n\n    pip3 install --user fr\n\nTo install system-wide as root::\n\n    sudo -H pip3 install fr\n\n\n|\n\nWindows\n~~~~~~~~~\n\nSupport is still experimental.\nCould use some help as Win7 in a VM is all I have access to these days.\n\nTo install per user::\n\n    pip3 install --user fr[win]\n\n(You'll need to add the install folder to your ``PATH``,\ne.g. ``C:\\Users\\%USERNAME%\\Python36\\Scripts``.)\n\nTo install for everyone, run as Admin::\n\n    pip3 install fr[win]    # installs winstats, colorama\n\n\n|\n\nMac OS X\n~~~~~~~~~\n\nYes, it supports that too.\nSupport is experimental as well::\n\n    [sudo] pip3 install [--user] fr\n\nAnd off you go.\n\nFYI, the Unicode block characters look a bit better with Source Code Pro as the\nterminal font\u2014YMMV.\n\nCould use some help here also,\nborrowing a Mac is my only option.\nCurrently runs\n``sysctl``, ``vm_stat``, and ``df`` under the hood,\nhoping there are better options?\n\n\nLimitations\n~~~~~~~~~~~~~\n\nOptical, Network, Removable\n+++++++++++++++++++++++++++++\n\nBoth Windows and Mac OS are not currently able to detect whether extended\nproperties of filesystems.\nThe port to Python 3 seems to have broken Windows in that regard,\nwhich used to work.\n\nUnicode\n+++++++++\n\nI've given up on Unicode icons (for now) on the Windows console and went back\nto ASCII.\nPerhaps it should print out \"conventional/high\" memory too.\n\nThe Linux console (the real boot up console, pre-X) has a very limited\ncharacter set and therefore uses ASCII as well.\n\nColors\n+++++++++\n\nBoth Windows and the Linux (non-X11) consoles are limited to sixteen colors.\nApparently Windows 10 has been upgraded to support more,\nbut I haven't yet found documentation on how to detect it.\n\n\nUse\n------------\n\nRun it ;)\n\n::\n\n    fr\n\nAnd of course there are a number of options,\nspit out when this is typed::\n\n    fr -h\n\n\n.. note::\n\n    Output will be in a compact format when the width of the\n    terminal/console is under 90 characters.\n    Give it more and it will expand to fill available space.\n\n\n|\n\nLicense\n~~~~~~~~~\n\n`GPL, version 3+ <http://www.gnu.org/licenses/gpl.html>`_.\n\n|\n\nRelease Notes\n~~~~~~~~~~~~~~~\n\n- 3.01 - Fix locale.format on Python 3.12, skip devtmpfs by default on Linux.\n- 3.00 - Major rewrite to support Python 3.6,\n  refactor shitty thirteen year-old code,\n  remove deps on Dbus and Udisks.\n  Still needs a lot of work.\n",
    "bugtrack_url": null,
    "license": "GPLv3",
    "summary": "A program to print resources in delicious flavors.",
    "version": "3.1",
    "project_urls": {
        "Homepage": "https://github.com/mixmastamyk/fr"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "e24272f5957ce49de696510f87bea407592c13d274ebc4f98394fe6e4720a281",
                "md5": "2bd52fd73ffdb17702ec6dca46111be2",
                "sha256": "7b6ce3b4513827da06947ebfe412ed260de987b05006953f312c4c0802a6d6bb"
            },
            "downloads": -1,
            "filename": "fr-3.1.tar.gz",
            "has_sig": false,
            "md5_digest": "2bd52fd73ffdb17702ec6dca46111be2",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">3.6.0",
            "size": 32980,
            "upload_time": "2024-04-07T22:59:36",
            "upload_time_iso_8601": "2024-04-07T22:59:36.510874Z",
            "url": "https://files.pythonhosted.org/packages/e2/42/72f5957ce49de696510f87bea407592c13d274ebc4f98394fe6e4720a281/fr-3.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-04-07 22:59:36",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "mixmastamyk",
    "github_project": "fr",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "fr"
}
        
Elapsed time: 0.20854s