Metadata-Version: 2.1
Name: i3pyblocks
Version: 2020.9.20
Summary: A replacement for i3status, written in Python using asyncio.
Home-page: https://i3pyblocks.readthedocs.io
Author: Thiago Kenji Okada
Author-email: thiagokokada@gmail.com
License: UNKNOWN
Project-URL: Documentation, https://i3pyblocks.readthedocs.io
Project-URL: Source, https://github.com/thiagokokada/i3pyblocks
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: POSIX
Requires-Python: >=3.6
Description-Content-Type: text/markdown
Provides-Extra: blocks.dbus
Requires-Dist: dbus-next (>=0.1.1) ; extra == 'blocks.dbus'
Provides-Extra: blocks.http
Requires-Dist: aiohttp (>=3.4.0) ; extra == 'blocks.http'
Provides-Extra: blocks.i3ipc
Requires-Dist: i3ipc (>=2.0.1) ; extra == 'blocks.i3ipc'
Provides-Extra: blocks.inotify
Requires-Dist: aionotify (>=0.2.0) ; extra == 'blocks.inotify'
Provides-Extra: blocks.ps
Requires-Dist: psutil (>=5.4.8) ; extra == 'blocks.ps'
Provides-Extra: blocks.pulse
Requires-Dist: pulsectl (>=18.10.5) ; extra == 'blocks.pulse'
Provides-Extra: blocks.x11
Requires-Dist: python-xlib (>=0.2.8) ; extra == 'blocks.x11'
Provides-Extra: dev
Requires-Dist: black ; extra == 'dev'
Requires-Dist: flake8 ; extra == 'dev'
Requires-Dist: flake8-bugbear ; extra == 'dev'
Requires-Dist: isort ; extra == 'dev'
Requires-Dist: mypy ; extra == 'dev'
Requires-Dist: pip-tools ; extra == 'dev'
Provides-Extra: docs
Requires-Dist: sphinx ; extra == 'docs'
Requires-Dist: sphinx-autoapi ; extra == 'docs'
Requires-Dist: sphinx-rtd-theme ; extra == 'docs'
Provides-Extra: test
Requires-Dist: asynctest ; extra == 'test'
Requires-Dist: pytest ; extra == 'test'
Requires-Dist: pytest-aiohttp ; extra == 'test'
Requires-Dist: pytest-asyncio ; extra == 'test'
Requires-Dist: pytest-cov ; extra == 'test'

# i3pyblocks

[![PyPI version](https://badge.fury.io/py/i3pyblocks.svg)](https://badge.fury.io/py/i3pyblocks)
[![Test](https://github.com/thiagokokada/i3pyblocks/workflows/Test/badge.svg)](https://github.com/thiagokokada/i3pyblocks/actions)
[![Lint](https://github.com/thiagokokada/i3pyblocks/workflows/Lint/badge.svg)](https://github.com/thiagokokada/i3pyblocks/actions)
[![Documentation Status](https://readthedocs.org/projects/i3pyblocks/badge/?version=latest)](https://i3pyblocks.readthedocs.io/en/latest/?badge=latest)
[![Codecov](https://codecov.io/gh/thiagokokada/i3pyblocks/branch/master/graph/badge.svg)](https://codecov.io/gh/thiagokokada/i3pyblocks)

![Screenshot](https://raw.github.com/thiagokokada/i3pyblocks/master/docs/_static/screenshot.png)

A replacement for i3status, written in [Python][python] using [asyncio][asyncio].

Works in both [i3wm][i3wm] and [sway][sway].

For Python 3.6+.

## Installation and Usage

Look at the [example.py][example.py] file for inspiration and check the
[User guide][user-guide] section of documentation.

## Development

To setup a development environment, create a new [venv][venv] first and run:

```shell
make dev-install
```

To run the tests, you may run:

```shell
make tests
```

Look at the included `Makefile` for more available commands.


If you're using [NixOS][nixos] or nixpkgs, an alternative way to
get a working environment variable is using the `shell.nix` file included in
this repo:

```shell
nix-shell shell-dev.nix
```

For more information, look at [Creating a new block][creating-a-new-block]
section of documentation.

## Contributing

Pull requests are welcome. For major changes, please open an issue first to
discuss what you would like to change.

Please make sure to update tests as appropriate.

## License

[MIT](https://choosealicense.com/licenses/mit/)

[python]: https://www.python.org/
[asyncio]: https://docs.python.org/3/library/asyncio.html
[i3wm]: https://i3wm.org/
[sway]: https://swaywm.org/
[venv]: https://docs.python.org/3/library/venv.html
[user-guide]: https://i3pyblocks.readthedocs.io/en/latest/user-guide.html
[nixos]: https://nixos.org/
[creating-a-new-block]: https://i3pyblocks.readthedocs.io/en/latest/creating-a-new-block.html
[example.py]: https://github.com/thiagokokada/i3pyblocks/blob/master/example.py


