rofi-tmuxp


Namerofi-tmuxp JSON
Version 0.6.0 PyPI version JSON
download
home_pageNone
SummaryRofi script to launch tmuxp sessions.
upload_time2024-10-07 17:19:29
maintainerNone
docs_urlNone
authorNone
requires_python~=3.8
licenseNone
keywords rofi tmux tmuxp
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            ==========
Rofi TmuxP
==========

.. pull-quote::

   Use Rofi_ to launch tmuxp_ sessions.

.. image:: https://img.shields.io/pypi/v/rofi-tmuxp.svg
    :target: https://pypi.org/project/rofi-tmuxp/

.. image:: https://img.shields.io/pypi/pyversions/rofi-tmuxp.svg
    :target: https://pypi.org/project/rofi-tmuxp/

.. image:: https://img.shields.io/pypi/format/rofi-tmuxp.svg
    :target: https://pypi.org/project/rofi-tmuxp/

.. image:: https://github.com/heindsight/rofi-tmuxp/actions/workflows/test.yaml/badge.svg?branch=master
    :target: https://github.com/heindsight/rofi-tmuxp/actions/workflows/test.yaml?query=branch%3Adevelop

.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
    :target: https://github.com/psf/black

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

.. code-block:: shell

   $ pip install rofi-tmuxp

Note
````

The ``rofi-tmuxp`` script uses the `tmuxp python API`_ to find your tmuxp
session config files. This means that you should install it in the same Python
environment as tmuxp.

Usage
-----

Without any command-line arguments, ``rofi-tmuxp`` will print out a list of
tmuxp session names to standard output. If a session name is passed as an
argument, it will attempt to launch that session in a new terminal.

To use with ``rofi``, you will need to add ``rofi-tmuxp`` as a "script" mode to
you rofi config file.  E.g.

.. code-block::

   configuration {
       /* Enable run and tmuxp modes */
       modi: "run,tmuxp:rofi-tmuxp";
   }

Then you can run rofi like:

.. code-block:: shell

   rofi -show tmuxp

License
-------

Copyright (c) Heinrich Kruger. Distributed under the `MIT license`_.


.. _Rofi: https://github.com/davatorium/rofi
.. _tmuxp: http://tmuxp.git-pull.com/
.. _tmuxp python API: https://tmuxp.git-pull.com/en/latest/api.html
.. _MIT license: https://github.com/heindsight/rofi-tmuxp/blob/master/LICENSE


            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "rofi-tmuxp",
    "maintainer": null,
    "docs_url": null,
    "requires_python": "~=3.8",
    "maintainer_email": null,
    "keywords": "rofi, tmux, tmuxp",
    "author": null,
    "author_email": "Heinrich Kruger <heindsight@kruger.dev>",
    "download_url": "https://files.pythonhosted.org/packages/bd/40/608e4f8a4345059a9fa55f755e79c77293f76f18898453622fa74fe494de/rofi_tmuxp-0.6.0.tar.gz",
    "platform": null,
    "description": "==========\nRofi TmuxP\n==========\n\n.. pull-quote::\n\n   Use Rofi_ to launch tmuxp_ sessions.\n\n.. image:: https://img.shields.io/pypi/v/rofi-tmuxp.svg\n    :target: https://pypi.org/project/rofi-tmuxp/\n\n.. image:: https://img.shields.io/pypi/pyversions/rofi-tmuxp.svg\n    :target: https://pypi.org/project/rofi-tmuxp/\n\n.. image:: https://img.shields.io/pypi/format/rofi-tmuxp.svg\n    :target: https://pypi.org/project/rofi-tmuxp/\n\n.. image:: https://github.com/heindsight/rofi-tmuxp/actions/workflows/test.yaml/badge.svg?branch=master\n    :target: https://github.com/heindsight/rofi-tmuxp/actions/workflows/test.yaml?query=branch%3Adevelop\n\n.. image:: https://img.shields.io/badge/code%20style-black-000000.svg\n    :target: https://github.com/psf/black\n\nInstallation\n------------\n\n.. code-block:: shell\n\n   $ pip install rofi-tmuxp\n\nNote\n````\n\nThe ``rofi-tmuxp`` script uses the `tmuxp python API`_ to find your tmuxp\nsession config files. This means that you should install it in the same Python\nenvironment as tmuxp.\n\nUsage\n-----\n\nWithout any command-line arguments, ``rofi-tmuxp`` will print out a list of\ntmuxp session names to standard output. If a session name is passed as an\nargument, it will attempt to launch that session in a new terminal.\n\nTo use with ``rofi``, you will need to add ``rofi-tmuxp`` as a \"script\" mode to\nyou rofi config file.  E.g.\n\n.. code-block::\n\n   configuration {\n       /* Enable run and tmuxp modes */\n       modi: \"run,tmuxp:rofi-tmuxp\";\n   }\n\nThen you can run rofi like:\n\n.. code-block:: shell\n\n   rofi -show tmuxp\n\nLicense\n-------\n\nCopyright (c) Heinrich Kruger. Distributed under the `MIT license`_.\n\n\n.. _Rofi: https://github.com/davatorium/rofi\n.. _tmuxp: http://tmuxp.git-pull.com/\n.. _tmuxp python API: https://tmuxp.git-pull.com/en/latest/api.html\n.. _MIT license: https://github.com/heindsight/rofi-tmuxp/blob/master/LICENSE\n\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "Rofi script to launch tmuxp sessions.",
    "version": "0.6.0",
    "project_urls": {
        "Homepage": "https://github.com/heindsight/rofi-tmuxp"
    },
    "split_keywords": [
        "rofi",
        " tmux",
        " tmuxp"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "5e2b87aba05f4adf85982b41d15f8820cf6a93bdedb6f4000b0d7ac387625958",
                "md5": "51d44bc35889b112b5bc90c258dc00fe",
                "sha256": "07225f6b01c50c814a404d0ef8df594c775bc0087e46bd34eee31eaeff238a89"
            },
            "downloads": -1,
            "filename": "rofi_tmuxp-0.6.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "51d44bc35889b112b5bc90c258dc00fe",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "~=3.8",
            "size": 5651,
            "upload_time": "2024-10-07T17:19:27",
            "upload_time_iso_8601": "2024-10-07T17:19:27.558974Z",
            "url": "https://files.pythonhosted.org/packages/5e/2b/87aba05f4adf85982b41d15f8820cf6a93bdedb6f4000b0d7ac387625958/rofi_tmuxp-0.6.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "bd40608e4f8a4345059a9fa55f755e79c77293f76f18898453622fa74fe494de",
                "md5": "0ef49f948171d5cf7e3a6e34ef6ab4af",
                "sha256": "dcce4f893ae329a2e5cf2d8fe0628484cd6c574404784836029c063bd6c87ec3"
            },
            "downloads": -1,
            "filename": "rofi_tmuxp-0.6.0.tar.gz",
            "has_sig": false,
            "md5_digest": "0ef49f948171d5cf7e3a6e34ef6ab4af",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "~=3.8",
            "size": 7521,
            "upload_time": "2024-10-07T17:19:29",
            "upload_time_iso_8601": "2024-10-07T17:19:29.213596Z",
            "url": "https://files.pythonhosted.org/packages/bd/40/608e4f8a4345059a9fa55f755e79c77293f76f18898453622fa74fe494de/rofi_tmuxp-0.6.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-10-07 17:19:29",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "heindsight",
    "github_project": "rofi-tmuxp",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "tox": true,
    "lcname": "rofi-tmuxp"
}
        
Elapsed time: 2.22065s