| Name | diarycli JSON |
| Version |
0.2.0
JSON |
| download |
| home_page | |
| Summary | A CLI program that help creates diary and organize them |
| upload_time | 2023-01-30 05:02:35 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | |
| license | MIT License Copyright (c) [2023] [Rocky Li] Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
diary
cli
vim
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
## DiaryCLI
`$ pip install diarycli`
One CLI command to create and organize your diaries in the terminal.
`$ diary` opens a CLI editor to today's diary (path: `$DIARY_DIR/year/month/date.md`)
`$ diary cat` cat the content of today's diary to terminal.
`$ diary 2020-01-01` create a diary entry for 2020/01/01 in the appropriate file path.
Use environment argument `DIARY_DIR` and `DIARY_EDITOR` to configure where the diary are and what editor to use, by default, it use `vim` as editor and `~/diary` as path for diary.
When installing via `pip`, if you see following message:
```
WARNING: The script diary is installed in '/some/path/examples/bin' which is not on PATH
Consider adding this directory to PATH or, if you prefer to suppress this warning, use --no-warn-script-location
```
You may want to add this location to `PATH`, to do that, add the following line to your `.rc` file:
```
export PATH=$PATH:/some/path/examples/bin
```
### Demo
### Inspiration
Inspiration from bash diary script that I have created and used for years: https://github.com/Aperocky/diaryman/blob/master/diaryman.sh
`pip` provides an easier way to package and distribute this software.
Raw data
{
"_id": null,
"home_page": "",
"name": "diarycli",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "diary,cli,vim",
"author": "",
"author_email": "Rocky Li <aperocky@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/16/2e/f9b19b840cf5e740fbae590047ee6f1bf180dbe80717ad2bcbafdc2cb647/diarycli-0.2.0.tar.gz",
"platform": null,
"description": "## DiaryCLI\n\n`$ pip install diarycli`\n\nOne CLI command to create and organize your diaries in the terminal.\n\n`$ diary` opens a CLI editor to today's diary (path: `$DIARY_DIR/year/month/date.md`)\n\n`$ diary cat` cat the content of today's diary to terminal.\n\n`$ diary 2020-01-01` create a diary entry for 2020/01/01 in the appropriate file path.\n\nUse environment argument `DIARY_DIR` and `DIARY_EDITOR` to configure where the diary are and what editor to use, by default, it use `vim` as editor and `~/diary` as path for diary.\n\nWhen installing via `pip`, if you see following message:\n\n```\nWARNING: The script diary is installed in '/some/path/examples/bin' which is not on PATH\nConsider adding this directory to PATH or, if you prefer to suppress this warning, use --no-warn-script-location\n```\n\nYou may want to add this location to `PATH`, to do that, add the following line to your `.rc` file:\n\n```\nexport PATH=$PATH:/some/path/examples/bin\n```\n\n### Demo\n\n\n\n### Inspiration\n\nInspiration from bash diary script that I have created and used for years: https://github.com/Aperocky/diaryman/blob/master/diaryman.sh\n\n`pip` provides an easier way to package and distribute this software.\n\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) [2023] [Rocky Li] Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
"summary": "A CLI program that help creates diary and organize them",
"version": "0.2.0",
"split_keywords": [
"diary",
"cli",
"vim"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "33dcbd14eab96b475949db26f50b89dd4ed566c5ec622d17156e2374e1c36762",
"md5": "ac814d3bd13e0bfbc1b24ecad2bc3889",
"sha256": "561d3ac5cf878b44e97bdfd33d467acac2195ee506c69668d2daf45a59ffc19f"
},
"downloads": -1,
"filename": "diarycli-0.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ac814d3bd13e0bfbc1b24ecad2bc3889",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 4219,
"upload_time": "2023-01-30T05:02:34",
"upload_time_iso_8601": "2023-01-30T05:02:34.166302Z",
"url": "https://files.pythonhosted.org/packages/33/dc/bd14eab96b475949db26f50b89dd4ed566c5ec622d17156e2374e1c36762/diarycli-0.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "162ef9b19b840cf5e740fbae590047ee6f1bf180dbe80717ad2bcbafdc2cb647",
"md5": "e6da12f6ff4334f65b86d29c1510dc3b",
"sha256": "5f16e56c934a7db7a215f5758f09f333e82088e61d4c9681bb1b103b59d708fd"
},
"downloads": -1,
"filename": "diarycli-0.2.0.tar.gz",
"has_sig": false,
"md5_digest": "e6da12f6ff4334f65b86d29c1510dc3b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 3291,
"upload_time": "2023-01-30T05:02:35",
"upload_time_iso_8601": "2023-01-30T05:02:35.772308Z",
"url": "https://files.pythonhosted.org/packages/16/2e/f9b19b840cf5e740fbae590047ee6f1bf180dbe80717ad2bcbafdc2cb647/diarycli-0.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-01-30 05:02:35",
"github": false,
"gitlab": false,
"bitbucket": false,
"lcname": "diarycli"
}
