| Name | keepmenu JSON |
| Version |
1.4.1
JSON |
| download |
| home_page | None |
| Summary | Dmenu frontend for Keepass databases |
| upload_time | 2024-01-24 19:09:42 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | None |
| license | None |
| keywords |
dmenu
keepass
keepassxc
rofi
wofi
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Keepmenu
Fully featured [Bemenu][7]/Dmenu/[Fuzzel][13]/[Rofi][2]//[Wofi][8]/[Yofi][9] frontend for
autotype and managing of Keepass databases.
Inspired in part by [Passhole][3], but more dmenu and less command line focused.
## Installation
`pip install --user keepmenu`
Ensure `~/.local/bin` is in your `$PATH`. Run `keepmenu` and enter your database
path, keyfile path, and password.
For full installation documention see the [installation docs][docs/install.md].
## Full Documentation
[Installation](docs/install.md) - [Configuration](docs/configure.md) - [Usage](docs/usage.md)
## Requirements
1. Python 3.7+
2. [Pykeepass][1] >= 4.0.0 and [pynput][5]
3. Bemenu, Dmenu, Fuzzel, Rofi, Wofi, or Yofi
4. xsel or wl-copy
5. (optional) Pinentry
6. (optional) xdotool (for X), [ydotool][10] or [wtype][11](for Wayland), [dotool][12] (X or Wayland).
## Features
- Supports .kdbx databases, not .kdb.
- Auto-type username and/or password on selection. Select to clipboard if
desired (clears clipboard after 30s).
- Background process allows selectable time-out for locking the database.
- Multiple databases can be unlocked and switched on the fly.
- Use a custom [Keepass 2.x style auto-type sequence][6].
- Type, view or edit any field.
- Open the URL in the default web browser.
- Edit notes using terminal or gui editor.
- Add and Delete entries.
- Add, delete, rename and move groups.
- Hide selected groups from the default and 'View/Type Individual entries' views.
- Configure the characters and groups of characters used during password
generation.
- Optional Pinentry support for secure passphrase entry.
- [Keepass field references][4] are supported.
- Display and manage expired passwords.
- Add, edit and type TOTP codes.
- Add, edit, type and delete custom attributes.
## License
- GPLv3
## Usage
`keepmenu [-h] [-a AUTOTYPE] [-c CONF_FILE] [-C] [-d DATABASE] [-k KEY_FILE] [-t]`
- Run `keepmenu` or bind to keystroke combination.
- Enter database path on first run.
- Start typing to match entries.
- [Configure](docs/configure.md) config.ini as desired.
- More detailed [usage information](docs/usage.md).
## Tests
To run tests in a venv: `make test`
## Development
- To install keepmenu in a venv: `make`
- Build man page from Markdown source: `make man`
- Using `hatch`:
- `hatch shell`: provies venv with editable installation.
- `hatch build` && `hatch publish`: build and publish to Pypi.
- Using `nix`:
- `nix develop path:.`: Provides development shell with all dependencies.
Edit and run similar to `pip install -e .` or `hatch shell`.
[1]: https://github.com/pschmitt/pykeepass "Pykeepass"
[2]: https://davedavenport.github.io/rofi/ "Rofi"
[3]: https://github.com/purduelug/passhole "Passhole"
[4]: https://keepass.info/help/base/fieldrefs.html "Keepass field references"
[5]: https://github.com/moses-palmer/pynput "pynput"
[6]: https://keepass.info/help/base/autotype.html#autoseq "Keepass 2.x codes"
[7]: https://github.com/Cloudef/bemenu "Bemenu"
[8]: https://hg.sr.ht/~scoopta/wofi "Wofi"
[9]: https://github.com/l4l/yofi "Yofi"
[10]: https://github.com/ReimuNotMoe/ydotool/ "Ydotool"
[11]: https://github.com/atx/wtype "Wtype"
[12]: https://git.sr.ht/~geb/dotool "Dotool"
[13]: https://codeberg.org/dnkl/fuzzel "Fuzzel"
Raw data
{
"_id": null,
"home_page": null,
"name": "keepmenu",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "dmenu,keepass,keepassxc,rofi,wofi",
"author": null,
"author_email": "Scott Hansen <tech@firecat53.net>",
"download_url": "https://files.pythonhosted.org/packages/5c/05/e7bd35a16d92c04581bcfb00f4e77001d151b167784fbddc52dcd759a344/keepmenu-1.4.1.tar.gz",
"platform": null,
"description": "# Keepmenu\n\n\n\n\n\nFully featured [Bemenu][7]/Dmenu/[Fuzzel][13]/[Rofi][2]//[Wofi][8]/[Yofi][9] frontend for\nautotype and managing of Keepass databases.\n\nInspired in part by [Passhole][3], but more dmenu and less command line focused.\n\n## Installation\n\n`pip install --user keepmenu`\n\nEnsure `~/.local/bin` is in your `$PATH`. Run `keepmenu` and enter your database\npath, keyfile path, and password.\n\nFor full installation documention see the [installation docs][docs/install.md].\n\n## Full Documentation\n\n[Installation](docs/install.md) - [Configuration](docs/configure.md) - [Usage](docs/usage.md)\n\n## Requirements\n\n1. Python 3.7+\n2. [Pykeepass][1] >= 4.0.0 and [pynput][5]\n3. Bemenu, Dmenu, Fuzzel, Rofi, Wofi, or Yofi\n4. xsel or wl-copy\n5. (optional) Pinentry\n6. (optional) xdotool (for X), [ydotool][10] or [wtype][11](for Wayland), [dotool][12] (X or Wayland).\n\n## Features\n\n- Supports .kdbx databases, not .kdb.\n- Auto-type username and/or password on selection. Select to clipboard if\n desired (clears clipboard after 30s).\n- Background process allows selectable time-out for locking the database.\n- Multiple databases can be unlocked and switched on the fly.\n- Use a custom [Keepass 2.x style auto-type sequence][6].\n- Type, view or edit any field.\n- Open the URL in the default web browser.\n- Edit notes using terminal or gui editor.\n- Add and Delete entries.\n- Add, delete, rename and move groups.\n- Hide selected groups from the default and 'View/Type Individual entries' views.\n- Configure the characters and groups of characters used during password\n generation.\n- Optional Pinentry support for secure passphrase entry.\n- [Keepass field references][4] are supported.\n- Display and manage expired passwords.\n- Add, edit and type TOTP codes.\n- Add, edit, type and delete custom attributes.\n\n## License\n\n- GPLv3\n\n## Usage\n\n`keepmenu [-h] [-a AUTOTYPE] [-c CONF_FILE] [-C] [-d DATABASE] [-k KEY_FILE] [-t]`\n\n- Run `keepmenu` or bind to keystroke combination.\n- Enter database path on first run.\n- Start typing to match entries.\n- [Configure](docs/configure.md) config.ini as desired.\n- More detailed [usage information](docs/usage.md).\n\n## Tests\n\nTo run tests in a venv: `make test`\n\n## Development\n\n- To install keepmenu in a venv: `make`\n\n- Build man page from Markdown source: `make man`\n- Using `hatch`:\n - `hatch shell`: provies venv with editable installation.\n - `hatch build` && `hatch publish`: build and publish to Pypi.\n- Using `nix`:\n - `nix develop path:.`: Provides development shell with all dependencies.\n Edit and run similar to `pip install -e .` or `hatch shell`.\n\n[1]: https://github.com/pschmitt/pykeepass \"Pykeepass\"\n[2]: https://davedavenport.github.io/rofi/ \"Rofi\"\n[3]: https://github.com/purduelug/passhole \"Passhole\"\n[4]: https://keepass.info/help/base/fieldrefs.html \"Keepass field references\"\n[5]: https://github.com/moses-palmer/pynput \"pynput\"\n[6]: https://keepass.info/help/base/autotype.html#autoseq \"Keepass 2.x codes\"\n[7]: https://github.com/Cloudef/bemenu \"Bemenu\"\n[8]: https://hg.sr.ht/~scoopta/wofi \"Wofi\"\n[9]: https://github.com/l4l/yofi \"Yofi\"\n[10]: https://github.com/ReimuNotMoe/ydotool/ \"Ydotool\"\n[11]: https://github.com/atx/wtype \"Wtype\"\n[12]: https://git.sr.ht/~geb/dotool \"Dotool\"\n[13]: https://codeberg.org/dnkl/fuzzel \"Fuzzel\"\n",
"bugtrack_url": null,
"license": null,
"summary": "Dmenu frontend for Keepass databases",
"version": "1.4.1",
"project_urls": {
"Homepage": "https://github.com/firecat53/keepmenu"
},
"split_keywords": [
"dmenu",
"keepass",
"keepassxc",
"rofi",
"wofi"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "72c2cafb311afd0ea05035d1724351b1ee9330e8f68f7c939b4d922a60f0de9e",
"md5": "14d82a781f94ed74cf05aa990588c246",
"sha256": "a80e75e7ae1c7838d4899909f48c3530123ce164813ba901f2fbb59bd6d98811"
},
"downloads": -1,
"filename": "keepmenu-1.4.1-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "14d82a781f94ed74cf05aa990588c246",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 66101,
"upload_time": "2024-01-24T19:09:40",
"upload_time_iso_8601": "2024-01-24T19:09:40.993412Z",
"url": "https://files.pythonhosted.org/packages/72/c2/cafb311afd0ea05035d1724351b1ee9330e8f68f7c939b4d922a60f0de9e/keepmenu-1.4.1-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "5c05e7bd35a16d92c04581bcfb00f4e77001d151b167784fbddc52dcd759a344",
"md5": "193c2cb2016fc1c6a4da1e4b0473e854",
"sha256": "c97e59bfdef61234e7bfa1e344f5f12d164ba44198600f702b562c178717a739"
},
"downloads": -1,
"filename": "keepmenu-1.4.1.tar.gz",
"has_sig": false,
"md5_digest": "193c2cb2016fc1c6a4da1e4b0473e854",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 36056,
"upload_time": "2024-01-24T19:09:42",
"upload_time_iso_8601": "2024-01-24T19:09:42.918878Z",
"url": "https://files.pythonhosted.org/packages/5c/05/e7bd35a16d92c04581bcfb00f4e77001d151b167784fbddc52dcd759a344/keepmenu-1.4.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-24 19:09:42",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "firecat53",
"github_project": "keepmenu",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "keepmenu"
}
