| Name | mawhrin JSON |
| Version |
0.2.0
JSON |
| download |
| home_page | None |
| Summary | A command-line note file manager in Python. |
| upload_time | 2024-09-07 03:31:46 |
| maintainer | None |
| docs_url | None |
| author | Stephen Malone |
| requires_python | >=3.11 |
| license | None |
| keywords |
cli
notes
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Mawhrin
[][pp]
[][ch]
[][is]
[][li]
[][py]
**Mawhrin** is a command-line note file manager, written in [Python 3.11][py] by [Stephen Malone][sm]. If you have a directory of plaintext note files, Mawhrin can give you a neat & tidy command-line interface to access, edit and organise them.
## Installation
You can install Mawhrin using Pip:
```
pip install mawhrin
```
Or just download the [latest release][rl] for your platform.
## Configuration
Mawhrin always operates within a directory of plaintext note files you specify, using two environment variables:
```bash
# The directory your note files are in.
export MAWHRIN_DIR = "$HOME/notes"
# The extension your note files use (with a leading dot).
export MAWHRIN_EXT = ".txt"
```
That's it. That's all you need to do.
## Commands
### Basic syntax
Your notes are always shown as lowercase names, e.g.: Mawhrin will show the note file `notes/foo.txt` as `foo`. The opposite is also true: if you ask Mawhrin to create the note `foo`, it will translate to `notes/foo.txt`.
For command-line help, call Mawhrin or a command with the the `-h` or `--help` options.
### List all notes
Use `list` to see all your notes, or notes with names matching some text:
```bash
$ mawhrin list
books_to_read
recipes_pasta
recipes_vegan
todos-2024
$ mawhrin list "2024"
todos-2024
```
- Matching uses case-insensitive substrings, so `TODO` will match `todos-2024`.
- If no matches are found, Mawhrin will print nothing.
### Search all notes
Use `find` to list notes containing some text:
```bash
$ mawhrin find "add the tofu"
recipes_vegan
```
- Searching also uses case-insensitive substrings.
- If no searches are found, Mawhrin will print nothing.
### Create a note
Use `make` to create a new empty note, or a note containing some text:
```bash
$ mawhrin make movies_to_watch
# or to add text:
$ mawhrin make movies_to_watch "- [ ] Contact"
```
- If the note already exists, Mawhrin will print an error.
### Print a note
Use `show` to print the contents of a note, if it exists:
```
$ mawhrin show books_to_read
- [x] The Player of Games by Iain M. Banks
```
- If the note doesn't exist, Mawhrin will print nothing.
## Contributing
Please submit all bug reports and feature requests to the [issue tracker][is], thank you.
[ch]: https://github.com/stvmln86/mawhrin/blob/main/changes.md
[is]: https://github.com/stvmln86/mawhrin/issues
[li]: https://github.com/stvmln86/mawhrin/blob/main/license.md
[rl]: https://github.com/stvmln86/mawhrin/releases/latest
[sm]: https://github.com/stvmln86
[pp]: https://pypi.org/project/mawhrin/
[py]: https://www.python.org/downloads/release/python-3110/
Raw data
{
"_id": null,
"home_page": null,
"name": "mawhrin",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.11",
"maintainer_email": null,
"keywords": "cli, notes",
"author": "Stephen Malone",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/7c/b7/8a4967f6a2b5eef0eaa3efdb2a362928af8f6defb68b445b1c8749a8861c/mawhrin-0.2.0.tar.gz",
"platform": null,
"description": "# Mawhrin\n\n[][pp]\n[][ch]\n[][is]\n[][li]\n[][py]\n\n**Mawhrin** is a command-line note file manager, written in [Python 3.11][py] by [Stephen Malone][sm]. If you have a directory of plaintext note files, Mawhrin can give you a neat & tidy command-line interface to access, edit and organise them.\n\n## Installation\n\nYou can install Mawhrin using Pip:\n\n```\npip install mawhrin\n```\n\nOr just download the [latest release][rl] for your platform.\n\n## Configuration\n\nMawhrin always operates within a directory of plaintext note files you specify, using two environment variables:\n\n```bash\n# The directory your note files are in.\nexport MAWHRIN_DIR = \"$HOME/notes\"\n\n# The extension your note files use (with a leading dot).\nexport MAWHRIN_EXT = \".txt\"\n```\n\nThat's it. That's all you need to do. \n\n## Commands\n\n### Basic syntax\n\nYour notes are always shown as lowercase names, e.g.: Mawhrin will show the note file `notes/foo.txt` as `foo`. The opposite is also true: if you ask Mawhrin to create the note `foo`, it will translate to `notes/foo.txt`. \n\nFor command-line help, call Mawhrin or a command with the the `-h` or `--help` options. \n\n### List all notes\n\nUse `list` to see all your notes, or notes with names matching some text:\n\n```bash\n$ mawhrin list\nbooks_to_read\nrecipes_pasta\nrecipes_vegan\ntodos-2024\n\n$ mawhrin list \"2024\"\ntodos-2024\n```\n\n- Matching uses case-insensitive substrings, so `TODO` will match `todos-2024`.\n- If no matches are found, Mawhrin will print nothing.\n\n### Search all notes\n\nUse `find` to list notes containing some text:\n\n```bash\n$ mawhrin find \"add the tofu\"\nrecipes_vegan\n```\n\n- Searching also uses case-insensitive substrings.\n- If no searches are found, Mawhrin will print nothing.\n\n### Create a note\n\nUse `make` to create a new empty note, or a note containing some text:\n\n```bash\n$ mawhrin make movies_to_watch\n# or to add text:\n$ mawhrin make movies_to_watch \"- [ ] Contact\"\n```\n\n- If the note already exists, Mawhrin will print an error.\n\n### Print a note\n\nUse `show` to print the contents of a note, if it exists:\n\n```\n$ mawhrin show books_to_read\n- [x] The Player of Games by Iain M. Banks\n```\n\n- If the note doesn't exist, Mawhrin will print nothing.\n\n## Contributing\n\nPlease submit all bug reports and feature requests to the [issue tracker][is], thank you. \n\n[ch]: https://github.com/stvmln86/mawhrin/blob/main/changes.md\n[is]: https://github.com/stvmln86/mawhrin/issues\n[li]: https://github.com/stvmln86/mawhrin/blob/main/license.md\n[rl]: https://github.com/stvmln86/mawhrin/releases/latest\n[sm]: https://github.com/stvmln86\n[pp]: https://pypi.org/project/mawhrin/\n[py]: https://www.python.org/downloads/release/python-3110/\n",
"bugtrack_url": null,
"license": null,
"summary": "A command-line note file manager in Python.",
"version": "0.2.0",
"project_urls": {
"Changes": "https://github.com/stvmln86/mawhrin/blob/main/changes.md",
"Github": "https://github.com/stvmln86/mawhrin",
"Issues": "https://github.com/stvmln86/mawhrin/issues"
},
"split_keywords": [
"cli",
" notes"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "8e6600dfe3c2b878f6dcece3a9c6a5e1fe6a332c16177e7e96ec17b53e712a1a",
"md5": "5abda2951174b01039a98d27a9553fc7",
"sha256": "f6699a3721639dba4fae9b1da73617094f0d9f161604799ce8d252a98693951f"
},
"downloads": -1,
"filename": "mawhrin-0.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "5abda2951174b01039a98d27a9553fc7",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11",
"size": 9847,
"upload_time": "2024-09-07T03:31:45",
"upload_time_iso_8601": "2024-09-07T03:31:45.388233Z",
"url": "https://files.pythonhosted.org/packages/8e/66/00dfe3c2b878f6dcece3a9c6a5e1fe6a332c16177e7e96ec17b53e712a1a/mawhrin-0.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "7cb78a4967f6a2b5eef0eaa3efdb2a362928af8f6defb68b445b1c8749a8861c",
"md5": "253a1bde05e00a5b226a4dfdcf1a5d9f",
"sha256": "b49f6d909f3e0799371fbd92ffdd9e1848d148e89b72cd3676ef34e296c23c5c"
},
"downloads": -1,
"filename": "mawhrin-0.2.0.tar.gz",
"has_sig": false,
"md5_digest": "253a1bde05e00a5b226a4dfdcf1a5d9f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11",
"size": 7890,
"upload_time": "2024-09-07T03:31:46",
"upload_time_iso_8601": "2024-09-07T03:31:46.424460Z",
"url": "https://files.pythonhosted.org/packages/7c/b7/8a4967f6a2b5eef0eaa3efdb2a362928af8f6defb68b445b1c8749a8861c/mawhrin-0.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-07 03:31:46",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "stvmln86",
"github_project": "mawhrin",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "mawhrin"
}
