README.md

Pext

Contents

• Introduction
• How it works
• Installation
  • GNU/Linux
  • macOS
  • Windows
• Usage
• Hotkeys
• Troubleshooting
  • GNU/Linux
  • Windows
• Community
• License

Introduction

Pext stands for Python-based extendable tool. It is built using Python 3 and Qt5 QML and has its behaviour decided by modules. Pext provides a simple window with a search bar, allowing modules to define what data is shown and how it is manipulated.

For example, say you want to use Pext as a password manager. You load in the pass module, and it will show you a list of your passwords which you can filter with the search bar. When you select a password in the list, it will copy the password to your clipboard and Pext will hide itself, waiting for you to ask for it again.

Depending on the module you choose, what entries are shown and what happens when you select an entry changes. So choose the module appropriate for what you want to do, and Pext makes it easy.

Several modules are available for effortless install right within Pext.

How it works

Pext is designed to quickly pop up and get out of your way as soon as you're done with something. It is recommended to bind Pext to some global hotkey, or possibly run multiple instances of it with different profiles under multiple hotkeys. Example Pext workflows look as follows:

Simply put:

• Open (Pext)
• Search (for something)
• Select (with Enter)
• Hide (automatically)

Installation

Note: If you run into any issues, please check out the troubleshooting section near the end of this document before reporting a bug.

GNU/Linux

Arch

Pext is available as pext and pext-git. These packages are maintained by Ivan Semkin.

Other distros

We recommend the AppImages under GitHub releases, but you can also install from PyPI.

For the stable version (PyPI):

pip3 install pext --user

For the git version (PyPI):

pip3 install git+https://github.com/Pext/Pext.git --user

On some systems, you may need to use pip instead of pip3.

Alternatively, you can install Pext from source (not recommended and unsupported)

macOS

A macOS .dmg file is available in the releases section on GitHub.

Alternatively, see Installing Pext from source (not recommended and unsupported)

Windows

A Windows installer is available in the releases section on GitHub.

Alternatively, see See Installing Pext from source (not recommended and unsupported)

Usage

To actually use Pext, you will first have to install one or more modules. Check out the Pext organisation on GitHub or use Module -> Install module -> From online module list in the application for a list of modules.

After installating at least one module, you can load it from the Module -> Load module menu. After that, experiment! Each module is different.

For command line options, use --help.

Hotkeys

Entry management

• Escape: Go one level up
• Tab: Tab-complete the current input
• Enter / Left mouse button: Select entry or run command
• Ctrl+Shift+. / Right mouse button on header: Open state menu
• Ctrl+. / Right mouse button on any item: Open context menu
• Ctrl+J / Down arrow: Go one entry down
• Ctrl+H / Up arrow: Go one entry up
• Ctrl+F / Page down: Go one page down
• Ctrl+B / Page up: Go one page up

Tab management

• Ctrl+T: Open new tab
• Ctrl+W: Close current tab
• Ctrl+Tab: Switch to next tab
• Ctrl+Shift+Tab: Switch to previous tab
• Alt+<number>: Switch to tab <number>
• F5: Reload tab, including code changes to the module

Session management

• Ctrl+Q: Quit and save the currently loaded modules and settings to the profile
• Ctrl+Shift+Q: Quit without saving to the profile

Troubleshooting

GNU/Linux

Installing module dependencies fails

Your distribution may ship with an outdated version of pip. Run pip install --upgrade pip (possibly as root) in a terminal.

Pext's window is completely white

The proprietary NVIDIA driver is known to cause this issue on at least Ubuntu. You can work around this by running sudo apt-get install python3-opengl.

Pext user report: https://github.com/Pext/Pext/issues/11 Ubuntu bug: https://bugs.launchpad.net/ubuntu/+source/python-qt4/+bug/941826

Community

If you need support or just want to chat with our community, we have the following options:

• IRC: #pext on OFTC (webchat)
• Matrix: #pext:matrix.org (webchat)
• Telegram: @PextTool

All these channels are linked to each other, so there is no need to worry about missing out.

We can also be reached on Twitter: @PextTool

License

Pext is licensed under the GNU GPLv3+, with exception of artwork and documentation, which are licensed under the Creative Commons Attribution Share-Alike 4.0 license.

Under artwork and documentation fall:

• All files in the following directories:
  • docs/
  • pext/images/
  • screenshots/
  • .github/
• All Markdown files in the root directory.
• logo.png

When attributing the logo (which was donated by vaeringjar), it should be attributed as Lilly the leoger by White Paper Fox. Alternatively, it may be referred to as the Pext logo. Please link to Pext with https://github.com/Pext/Pext or https://pext.hackerchick.me/ and to White Paper Fox with http://www.whitepaperfox.com/ where possible.