| Name | sunse JSON |
| Version |
0.1.0
JSON |
| download |
| home_page | |
| Summary | A plaintext note manager CLI in Python 3.10. |
| upload_time | 2023-03-11 03:13:53 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.10 |
| license | BSD 3-Clause License Copyright (c) 2023, Stephen Malone. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
| keywords |
notes
note-taking
cli
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Sunse
**Sunse** (*Stephen's Unseen Servant*, pronounced *sun·zee*) is a plaintext command-line note manager, written in Python 3.10.
Give Sunse a directory full of text files and it'll give you a complete management CLI, allowing you to read and manipulate your notes with ease.
```bash
# List all your files:
$ sunse list
future-projects
groceries
party-guest-list
# Show their contents:
$ sunse show party-guest-list
- Todd Chavez
- Princess Carolyn
- Diane Nguyen
- Mr. Peanutbutter (why)
# And manipulate them in all kinds of ways:
$ sunse append groceries vodka
$ sunse delete future-projects
$ sunse edit party-guest-list --command="vim -y"
```
## Installation
You can install Sunse from PyPi...
```
pip install sunse
```
...or download a build from the [latest release][bugs].
## Configuration
Sunse requires two environment variables to operate:
- Set `SUNSE_DIR` to the path of your notes directory:
```fish
set SUNSE_DIR "~/path/to/notes"
```
- Set `SUNSE_EXT` to the file extension your notes use:
```fish
set SUNSE_EXT ".txt"
```
That's it! That's all you need.
## Usage
Run `sunse --help` to see interactive help for all commands.
### List all notes
Use `sunse list` to list all existing note files in your directory (in alphabetical order):
```fish
$ sunse list
future-projects
groceries
party-guest-list
```
## Contributions
- Please submit all bug reports and feature suggestions to the [issue tracker][bugs].
- Run `pip install sunse[test]` to install additional testing dependencies.
[bugs]: https://github.com/wirehaiku/Sunse/issues
[rels]: https://github.com/wirehaiku/Sunse/releases
Raw data
{
"_id": null,
"home_page": "",
"name": "sunse",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": "",
"keywords": "notes,note-taking,cli",
"author": "",
"author_email": "Stephen Malone <none@example.com>",
"download_url": "https://files.pythonhosted.org/packages/b1/be/054697f6e0f3296616c90bbb4f9cba842be6392236ef3f09992cb553776b/sunse-0.1.0.tar.gz",
"platform": null,
"description": "# Sunse\n\n\n\n\n\n\n**Sunse** (*Stephen's Unseen Servant*, pronounced *sun\u00b7zee*) is a plaintext command-line note manager, written in Python 3.10.\n\nGive Sunse a directory full of text files and it'll give you a complete management CLI, allowing you to read and manipulate your notes with ease.\n\n```bash\n# List all your files:\n$ sunse list\nfuture-projects\ngroceries\nparty-guest-list\n\n# Show their contents:\n$ sunse show party-guest-list\n- Todd Chavez\n- Princess Carolyn\n- Diane Nguyen\n- Mr. Peanutbutter (why)\n\n# And manipulate them in all kinds of ways:\n$ sunse append groceries vodka\n$ sunse delete future-projects\n$ sunse edit party-guest-list --command=\"vim -y\"\n```\n\n## Installation\n\nYou can install Sunse from PyPi...\n\n```\npip install sunse\n```\n\n...or download a build from the [latest release][bugs].\n\n## Configuration\n\nSunse requires two environment variables to operate:\n\n- Set `SUNSE_DIR` to the path of your notes directory:\n\n```fish\nset SUNSE_DIR \"~/path/to/notes\"\n```\n\n- Set `SUNSE_EXT` to the file extension your notes use:\n\n```fish\nset SUNSE_EXT \".txt\"\n```\n\nThat's it! That's all you need.\n\n## Usage\n\nRun `sunse --help` to see interactive help for all commands.\n\n### List all notes\n\nUse `sunse list` to list all existing note files in your directory (in alphabetical order):\n\n```fish\n$ sunse list\nfuture-projects\ngroceries\nparty-guest-list\n```\n\n## Contributions\n\n- Please submit all bug reports and feature suggestions to the [issue tracker][bugs].\n- Run `pip install sunse[test]` to install additional testing dependencies.\n\n[bugs]: https://github.com/wirehaiku/Sunse/issues\n[rels]: https://github.com/wirehaiku/Sunse/releases\n",
"bugtrack_url": null,
"license": "BSD 3-Clause License Copyright (c) 2023, Stephen Malone. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS \"AS IS\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. ",
"summary": "A plaintext note manager CLI in Python 3.10.",
"version": "0.1.0",
"split_keywords": [
"notes",
"note-taking",
"cli"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "7b7380ae9370820b9b4cabf384273d02d4bc331da855d1ff7a7ef7db3ca26343",
"md5": "b2aff165fadb06d711ff4184c68fbac1",
"sha256": "ee4ed5dcb85c5b125e7186c0d0c4a5ba7b32294f834533a7c819326cc11f98a0"
},
"downloads": -1,
"filename": "sunse-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b2aff165fadb06d711ff4184c68fbac1",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 8195,
"upload_time": "2023-03-11T03:13:51",
"upload_time_iso_8601": "2023-03-11T03:13:51.989679Z",
"url": "https://files.pythonhosted.org/packages/7b/73/80ae9370820b9b4cabf384273d02d4bc331da855d1ff7a7ef7db3ca26343/sunse-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "b1be054697f6e0f3296616c90bbb4f9cba842be6392236ef3f09992cb553776b",
"md5": "451772e3f962b95e326939a68d00ef2d",
"sha256": "ac48f5da1fc17b5c4541f240de95888da51f3db8049401b41565e2a1a2837744"
},
"downloads": -1,
"filename": "sunse-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "451772e3f962b95e326939a68d00ef2d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 7998,
"upload_time": "2023-03-11T03:13:53",
"upload_time_iso_8601": "2023-03-11T03:13:53.922114Z",
"url": "https://files.pythonhosted.org/packages/b1/be/054697f6e0f3296616c90bbb4f9cba842be6392236ef3f09992cb553776b/sunse-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-03-11 03:13:53",
"github": false,
"gitlab": false,
"bitbucket": false,
"lcname": "sunse"
}
