| Name | quickremember JSON |
| Version |
0.1.0rc1
JSON |
| download |
| home_page | None |
| Summary | Simple CLI application to remember simple things. |
| upload_time | 2024-04-22 03:01:30 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.7 |
| license | MIT |
| keywords |
notes
cli
linux
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# QuickRemember
One problem I frequently run into while using my computer is simply needing to write something down to remember at a later date. I always open up a txt file, add in the info, save it as something random, and most of the time it gets lost on my hard drive. So, in the interest of making it easier to remember things and prevent random txt files from showing up in arbitrary places that you don't know if you should delete, I wrote this very simple program to quickly save and recall short bits of information.
QuickRemember is a simple command line interface application for quickly remembering the simple things. Its usage is meant to sound like natural language, and is very simple to use. QuickRemember is made up of 3 parts: storing, recalling, and forgetting. Storing and recalling exist within the same `remember` command, and forgetting is in the `forget` command.
## Install
`pip install quickremember`
This is the first time I have ever distributed a package. On some Linux distros, it's discouraged to globally install a package with pip rather than the distro's package manager, so I'm considering learning how to and publishing a flatpak to keep it accessible to any distro.
## Usage
### Storing
Storing information is very easy. Simply use `remember <what to remember>`. You can pass informmation to it inside or outside of quotations. QuickRemember concatenates arguments together to form the query. Just remember you need to escape special characters in some way, the easiest being to use quotes.
For example:
```bash
remember My API key is 12345
```
and
```bash
remember "My API key is 12345"
```
produce the exact same result. But,
```bash
remember I am cool & I like dolphins
```
and
```bash
remember "I am cool & I like dolphins"
```
most definitely do not, as in bash, the first example will fork the command and then we have a problem because I is probably not a command.
### Recalling
QuickRemember uses fuzzy searching (via `thefuzz` python package) to search for similar notes to a search query. Recalling, like storing, uses the remember keyword and is meant to be easy to use with natural language. To recall, simply add a `?` to the end of a search query. Once again, you can or don't have to use quotation marks.
```bash
remember my api key?
```
This will return the 5 closest-related "memories" in order of closeness.
You can also recall everything by simply executing `remember --everything`.
### Forgetting
If you are done with a piece of information and don't want to clutter your memroies, forgetting is easy as well, just run forget with a search query. The program will prompt for confirmation, and will then remove the memory.
```bash
forget my api key
```
You can also erase everything, but be careful because it is very permanent.
```bash
forget --everything
```
## Additional notes
QuickRemember stores everything in a plaintext file in your home (`~/.local/share/remember/data.txt`). It's not a safe place to store sensitive information as anyone with access to the system can see it. To combat this, I'm considering implementing a separate data file with encrypted information. This brings added complexity with security considerations such as secret key and data input being visible in the history, and the data output also possibly being visible in the history.
Some ways to combat this would be getting input where it does not display what you are typing, like how sudo gets password input. To keep data output secure, I could possibly directly copy it to clipboard or some sort of other way to securely give the information to the user, but I"m just not sure what the best way of doing this is.
## Potential future work
- [ ] Separate encrypted data storage
- [ ] Secure input for data and key entry
- [ ] Some search improvements
Raw data
{
"_id": null,
"home_page": null,
"name": "quickremember",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": "notes, cli, linux",
"author": null,
"author_email": "Trevin Jones <trevindjones@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/53/2d/7a0230c7814a7982878011cd2c0d6ffc95e513c68f93867a000017ee5b5a/quickremember-0.1.0rc1.tar.gz",
"platform": null,
"description": "# QuickRemember\n\nOne problem I frequently run into while using my computer is simply needing to write something down to remember at a later date. I always open up a txt file, add in the info, save it as something random, and most of the time it gets lost on my hard drive. So, in the interest of making it easier to remember things and prevent random txt files from showing up in arbitrary places that you don't know if you should delete, I wrote this very simple program to quickly save and recall short bits of information.\n\nQuickRemember is a simple command line interface application for quickly remembering the simple things. Its usage is meant to sound like natural language, and is very simple to use. QuickRemember is made up of 3 parts: storing, recalling, and forgetting. Storing and recalling exist within the same `remember` command, and forgetting is in the `forget` command.\n\n## Install\n\n`pip install quickremember`\n\nThis is the first time I have ever distributed a package. On some Linux distros, it's discouraged to globally install a package with pip rather than the distro's package manager, so I'm considering learning how to and publishing a flatpak to keep it accessible to any distro.\n\n## Usage\n\n### Storing\n\nStoring information is very easy. Simply use `remember <what to remember>`. You can pass informmation to it inside or outside of quotations. QuickRemember concatenates arguments together to form the query. Just remember you need to escape special characters in some way, the easiest being to use quotes.\n\nFor example:\n\n```bash\nremember My API key is 12345\n```\n\nand\n\n```bash\nremember \"My API key is 12345\"\n```\n\nproduce the exact same result. But, \n\n```bash\nremember I am cool & I like dolphins\n```\n\nand\n\n```bash\nremember \"I am cool & I like dolphins\"\n```\n\nmost definitely do not, as in bash, the first example will fork the command and then we have a problem because I is probably not a command.\n\n### Recalling\n\nQuickRemember uses fuzzy searching (via `thefuzz` python package) to search for similar notes to a search query. Recalling, like storing, uses the remember keyword and is meant to be easy to use with natural language. To recall, simply add a `?` to the end of a search query. Once again, you can or don't have to use quotation marks.\n\n```bash\nremember my api key?\n```\n\nThis will return the 5 closest-related \"memories\" in order of closeness.\n\nYou can also recall everything by simply executing `remember --everything`.\n\n### Forgetting\n\nIf you are done with a piece of information and don't want to clutter your memroies, forgetting is easy as well, just run forget with a search query. The program will prompt for confirmation, and will then remove the memory.\n\n```bash\nforget my api key\n```\n\nYou can also erase everything, but be careful because it is very permanent.\n\n```bash\nforget --everything\n```\n\n## Additional notes\n\nQuickRemember stores everything in a plaintext file in your home (`~/.local/share/remember/data.txt`). It's not a safe place to store sensitive information as anyone with access to the system can see it. To combat this, I'm considering implementing a separate data file with encrypted information. This brings added complexity with security considerations such as secret key and data input being visible in the history, and the data output also possibly being visible in the history.\n\nSome ways to combat this would be getting input where it does not display what you are typing, like how sudo gets password input. To keep data output secure, I could possibly directly copy it to clipboard or some sort of other way to securely give the information to the user, but I\"m just not sure what the best way of doing this is.\n\n## Potential future work\n\n- [ ] Separate encrypted data storage\n- [ ] Secure input for data and key entry\n- [ ] Some search improvements \n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Simple CLI application to remember simple things.",
"version": "0.1.0rc1",
"project_urls": null,
"split_keywords": [
"notes",
" cli",
" linux"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "eaaf328c016b829f2c5a5616037d453fd263fa0ea25827dd459df614258d85b4",
"md5": "a45a806e7fb6a098fc5439f4e5b36525",
"sha256": "ea7253403ae5052d3602526ea5cfc05fa8774d50a82d4dc6f8ed7b563a874c1b"
},
"downloads": -1,
"filename": "quickremember-0.1.0rc1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a45a806e7fb6a098fc5439f4e5b36525",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 6490,
"upload_time": "2024-04-22T03:01:28",
"upload_time_iso_8601": "2024-04-22T03:01:28.956434Z",
"url": "https://files.pythonhosted.org/packages/ea/af/328c016b829f2c5a5616037d453fd263fa0ea25827dd459df614258d85b4/quickremember-0.1.0rc1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "532d7a0230c7814a7982878011cd2c0d6ffc95e513c68f93867a000017ee5b5a",
"md5": "864b883ac9f7d8ca24fd1aef8c2185cf",
"sha256": "d3eb07b3644c50eba10d8a1cf151d06c066bd7fc000720bea7288dd7277a2788"
},
"downloads": -1,
"filename": "quickremember-0.1.0rc1.tar.gz",
"has_sig": false,
"md5_digest": "864b883ac9f7d8ca24fd1aef8c2185cf",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 5398,
"upload_time": "2024-04-22T03:01:30",
"upload_time_iso_8601": "2024-04-22T03:01:30.495637Z",
"url": "https://files.pythonhosted.org/packages/53/2d/7a0230c7814a7982878011cd2c0d6ffc95e513c68f93867a000017ee5b5a/quickremember-0.1.0rc1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-22 03:01:30",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "quickremember"
}
