usts

Name	usts JSON
Version	0.1.81 JSON
	download
home_page	https://notabug.org/loliconshik3/usts
Summary	Simple cli tool for creating status text to something like dwm-bar.
upload_time	2023-04-08 05:10:57
maintainer
docs_url	None
author	loliconshik3
requires_python
license
keywords
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # usts 

Simple cli tool for creating status text to something like dwm-bar.

## Modules

| Module    | Dependencies | Description                                                                                                            |
| :---:     | :---:        | :---                                                                                                                   |
| `str`     |              | Display string.                                                                                                        |
| `time`    | `datetime`   | Display current time with strftime formating.                                                                          |
| `cpu`     | `psutil`     | Display percent of cpu usage.                                                                                          |
| `ram`     | `psutil`     | Display memory usage (percent, available, etc...)                                                                      |
| `disk`    | `os`         | Display disk usage (free, available, total)                                                                            |
| `temp`    | `psutil`     | Display temperature (cpu, gpu, etc...)                                                                                 | 
| `weather` | `requests`   | Display weather from city with openweathermap.org api. [Weather icons.](https://github.com/erikflowers/weather-icons)  |
| `xkbstate`| `subprocess` | Display keyboard layout with [xkblayout-state](https://github.com/nonpop/xkblayout-state) utility.                     | 
| `bat`     | `psutil`     | Display battery level.                                                                                                 |

## Installation

```sh
$ pip install usts
```

## ~/.config/usts/config.py example

```py
# import modules from mkmod.py file
from usts.mkmod import *
# You also can import each module at self
from usts.modules.modcpu import ModCPU

# setup list of items
items = [
    ModuleWeather("API_KEY", 
                  city="London", country="UK"),
    ModuleTemp(),
    ModuleCPU(),
    # print example -> RAM: 10.1/16.0Gb
    ModuleRAM("RAM: {used}/{total}{data_format}", data_format="Gb"),
    # print example -> /: 121.3Gb
    ModuleDisk("{path}: {free}{data_format}"),  
    ModuleTime(),
    ModuleStr("☭")
]

# Execute is action with status
#   setxroot -> setxroot -name "status"
#   stdout   -> just print status in terminal
execute = "stdout"
# Separator between modules
#   like: text1 SEPARATOR text2 SEPARATOR text3
separator = " | "
# Update periodic is sleep time between updating display
update_periodic = 1.0
```

## Usage

```sh
$ usts
```

## Contacts

| Contact                                               | Description       |
| :---:                                                 | :---              |
| [`Matrix`](https://matrix.to/#/#librehub:matrix.org)  | Matrix server.    |
| [`Discord`](https://discord.gg/naGkzRN)               | Discord server.   |

## Donates
**Monero:** `47KkgEb3agJJjSpeW1LpVi1M8fsCfREhnBCb1yib5KQgCxwb6j47XBQAamueByrLUceRinJqveZ82UCbrGqrsY9oNuZ97xN`


            

Raw data

            {
    "_id": null,
    "home_page": "https://notabug.org/loliconshik3/usts",
    "name": "usts",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "",
    "author": "loliconshik3",
    "author_email": "",
    "download_url": "",
    "platform": null,
    "description": "# usts \n\nSimple cli tool for creating status text to something like dwm-bar.\n\n## Modules\n\n| Module    | Dependencies | Description                                                                                                            |\n| :---:     | :---:        | :---                                                                                                                   |\n| `str`     |              | Display string.                                                                                                        |\n| `time`    | `datetime`   | Display current time with strftime formating.                                                                          |\n| `cpu`     | `psutil`     | Display percent of cpu usage.                                                                                          |\n| `ram`     | `psutil`     | Display memory usage (percent, available, etc...)                                                                      |\n| `disk`    | `os`         | Display disk usage (free, available, total)                                                                            |\n| `temp`    | `psutil`     | Display temperature (cpu, gpu, etc...)                                                                                 | \n| `weather` | `requests`   | Display weather from city with openweathermap.org api. [Weather icons.](https://github.com/erikflowers/weather-icons)  |\n| `xkbstate`| `subprocess` | Display keyboard layout with [xkblayout-state](https://github.com/nonpop/xkblayout-state) utility.                     | \n| `bat`     | `psutil`     | Display battery level.                                                                                                 |\n\n## Installation\n\n```sh\n$ pip install usts\n```\n\n## ~/.config/usts/config.py example\n\n```py\n# import modules from mkmod.py file\nfrom usts.mkmod import *\n# You also can import each module at self\nfrom usts.modules.modcpu import ModCPU\n\n# setup list of items\nitems = [\n    ModuleWeather(\"API_KEY\", \n                  city=\"London\", country=\"UK\"),\n    ModuleTemp(),\n    ModuleCPU(),\n    # print example -> RAM: 10.1/16.0Gb\n    ModuleRAM(\"RAM: {used}/{total}{data_format}\", data_format=\"Gb\"),\n    # print example -> /: 121.3Gb\n    ModuleDisk(\"{path}: {free}{data_format}\"),  \n    ModuleTime(),\n    ModuleStr(\"\u262d\")\n]\n\n# Execute is action with status\n#   setxroot -> setxroot -name \"status\"\n#   stdout   -> just print status in terminal\nexecute = \"stdout\"\n# Separator between modules\n#   like: text1 SEPARATOR text2 SEPARATOR text3\nseparator = \" | \"\n# Update periodic is sleep time between updating display\nupdate_periodic = 1.0\n```\n\n## Usage\n\n```sh\n$ usts\n```\n\n## Contacts\n\n| Contact                                               | Description       |\n| :---:                                                 | :---              |\n| [`Matrix`](https://matrix.to/#/#librehub:matrix.org)  | Matrix server.    |\n| [`Discord`](https://discord.gg/naGkzRN)               | Discord server.   |\n\n## Donates\n**Monero:** `47KkgEb3agJJjSpeW1LpVi1M8fsCfREhnBCb1yib5KQgCxwb6j47XBQAamueByrLUceRinJqveZ82UCbrGqrsY9oNuZ97xN`\n\n",
    "bugtrack_url": null,
    "license": "",
    "summary": "Simple cli tool for creating status text to something like dwm-bar.",
    "version": "0.1.81",
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "541c8c9bcdf37969504d4355b02a8591e2d87e35a8fd0e25fbfe83aae40ab08e",
                "md5": "10617ecbd6171b4367990273bf60061f",
                "sha256": "a27bdf7a3b2cbf2dff0e73a87d1aca57a3cf247a2f838d51f549a9826d2867a8"
            },
            "downloads": -1,
            "filename": "usts-0.1.81-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "10617ecbd6171b4367990273bf60061f",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 23000,
            "upload_time": "2023-04-08T05:10:57",
            "upload_time_iso_8601": "2023-04-08T05:10:57.116180Z",
            "url": "https://files.pythonhosted.org/packages/54/1c/8c9bcdf37969504d4355b02a8591e2d87e35a8fd0e25fbfe83aae40ab08e/usts-0.1.81-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-04-08 05:10:57",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "lcname": "usts"
}