| Name | pmemo JSON |
| Version |
0.4.0
JSON |
| download |
| home_page | https://github.com/Asugawara/pmemo |
| Summary | Pmemo is a command-line memo editor designed for seamless editing directly in the terminal environment. It offers a range of features to enhance your memo-taking experience and leverages the power of OpenAI's ChatGPT. |
| upload_time | 2024-02-18 15:33:50 |
| maintainer | |
| docs_url | None |
| author | Asugawara |
| requires_python | >=3.9,<4.0 |
| license | MIT |
| keywords |
memo
tui
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Pmemo
**Pmemo** is a command-line memo editor designed for seamless editing directly in the terminal environment. It offers a range of features to enhance your memo-taking experience and leverages the power of OpenAI's ChatGPT.
# Features
- Rebind `ctrl-o` to request to **ChatGPT**
- Rebind `ctrl-t` to quickly access frequently used registered prompts
- CUI memo application that allows seamless editing directly in the terminal
- No fullscreen mode, keeping your workflow within the terminal
- Efficient search functionality for your memos
- Easily customizable to fit your preferences
- Execute code blocks written by you or ChatGPT immediately (Python only)
# Installation
```bash
$ pip install pmemo
```
# Usage
command | description
-- | --
`pm` or `pm new` | create new memo
`pm edit` | edit memo
`pm remove` | remove memo
`pm list` | list all memos
`pm preview` | preview memo(markdown) on terminal
`pm preference` | please refer to the [Preference section](https://github.com/Asugawara/pmemo#Preference)
`pm template` | create a new prompt template for completion using `ctrl-t`
`pm template -e` | edit an existing prompt template.
`pm run` | execute code blocks within your memos.
# Preference
name | default | description
-- | -- | --
out_dir | `$HOME/.pmemo` | specifies the directory where Pmemo saves memos
memo_preference.max_title_length | 30 | sets the maximum length of a memo title
editor_preference.prompt_spaces | 4 | defines the number of spaces used for line numbering in the editor
editor_preference.style_name | "github-dark" | sets the style of the editor
editor_preference.indentation_spaces | 4 | sets the number of spaces for indentation (tab size)
openai_preference.api_key | None | The OpenAI API uses API keys for authentication
openai_preference.model | "gpt-3.5-turbo" | ID of the model to use
openai_preference.max_tokens | 16 | the maximum number of tokens to generate in the completion
openai_preference.temperature | 0 | what sampling temperature to use, between 0 and 2
openai_preference.n | 1 | how many completions to generate for each prompt
Note: To enable ChatGPT functionality, make sure to set your OpenAI API key as an environment variable or preference.
# Versioning
This repo uses [Semantic Versioning](https://semver.org/).
# License
**pmemo** is released under the MIT License. See [LICENSE](/LICENSE) for additional details.
Raw data
{
"_id": null,
"home_page": "https://github.com/Asugawara/pmemo",
"name": "pmemo",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.9,<4.0",
"maintainer_email": "",
"keywords": "memo,TUI",
"author": "Asugawara",
"author_email": "asgasw@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/61/16/0a77e92e7cb93a13f9e315147326aa0d3f6d5f2fef23198090c4e67228bc/pmemo-0.4.0.tar.gz",
"platform": null,
"description": "\n\n\n\n\n\n# Pmemo\n\n**Pmemo** is a command-line memo editor designed for seamless editing directly in the terminal environment. It offers a range of features to enhance your memo-taking experience and leverages the power of OpenAI's ChatGPT.\n\n\n\n# Features\n- Rebind `ctrl-o` to request to **ChatGPT**\n- Rebind `ctrl-t` to quickly access frequently used registered prompts\n- CUI memo application that allows seamless editing directly in the terminal\n- No fullscreen mode, keeping your workflow within the terminal\n- Efficient search functionality for your memos\n- Easily customizable to fit your preferences\n- Execute code blocks written by you or ChatGPT immediately (Python only)\n\n# Installation\n\n```bash\n$ pip install pmemo\n```\n\n# Usage\n\ncommand | description\n-- | --\n`pm` or `pm new` | create new memo\n`pm edit` | edit memo\n`pm remove` | remove memo\n`pm list` | list all memos\n`pm preview` | preview memo(markdown) on terminal\n`pm preference` | please refer to the [Preference section](https://github.com/Asugawara/pmemo#Preference)\n`pm template` | create a new prompt template for completion using `ctrl-t`\n`pm template -e` | edit an existing prompt template.\n`pm run` | execute code blocks within your memos.\n\n\n# Preference\n\nname | default | description\n-- | -- | --\nout_dir | `$HOME/.pmemo` | specifies the directory where Pmemo saves memos\nmemo_preference.max_title_length | 30 | sets the maximum length of a memo title\neditor_preference.prompt_spaces | 4 | defines the number of spaces used for line numbering in the editor\neditor_preference.style_name | \"github-dark\" | sets the style of the editor\neditor_preference.indentation_spaces | 4 | sets the number of spaces for indentation (tab size)\nopenai_preference.api_key | None | The OpenAI API uses API keys for authentication\nopenai_preference.model | \"gpt-3.5-turbo\" | ID of the model to use\nopenai_preference.max_tokens | 16 | the maximum number of tokens to generate in the completion\nopenai_preference.temperature | 0 | what sampling temperature to use, between 0 and 2\nopenai_preference.n | 1 | how many completions to generate for each prompt\n\nNote: To enable ChatGPT functionality, make sure to set your OpenAI API key as an environment variable or preference.\n\n# Versioning\nThis repo uses [Semantic Versioning](https://semver.org/).\n\n# License\n**pmemo** is released under the MIT License. See [LICENSE](/LICENSE) for additional details.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Pmemo is a command-line memo editor designed for seamless editing directly in the terminal environment. It offers a range of features to enhance your memo-taking experience and leverages the power of OpenAI's ChatGPT.",
"version": "0.4.0",
"project_urls": {
"Homepage": "https://github.com/Asugawara/pmemo",
"Repository": "https://github.com/Asugawara/pmemo"
},
"split_keywords": [
"memo",
"tui"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e3782194388f5a877ed50783281b0f9cd62cb0c3e2834df81f36ed0a11542270",
"md5": "f7f42e0b0a0179dabad8eba356115cd5",
"sha256": "1240a95ee42efcc92f22f18bda9ddfc566dbc3784915d0f087ca69964dbf45ee"
},
"downloads": -1,
"filename": "pmemo-0.4.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f7f42e0b0a0179dabad8eba356115cd5",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9,<4.0",
"size": 18484,
"upload_time": "2024-02-18T15:33:49",
"upload_time_iso_8601": "2024-02-18T15:33:49.032158Z",
"url": "https://files.pythonhosted.org/packages/e3/78/2194388f5a877ed50783281b0f9cd62cb0c3e2834df81f36ed0a11542270/pmemo-0.4.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "61160a77e92e7cb93a13f9e315147326aa0d3f6d5f2fef23198090c4e67228bc",
"md5": "278d1e3a7723b114ec992d61710a6eec",
"sha256": "cdf94608cd4b532a856c8ea19b3591b85af2995e8f60e497d08f07a03850a76f"
},
"downloads": -1,
"filename": "pmemo-0.4.0.tar.gz",
"has_sig": false,
"md5_digest": "278d1e3a7723b114ec992d61710a6eec",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9,<4.0",
"size": 15034,
"upload_time": "2024-02-18T15:33:50",
"upload_time_iso_8601": "2024-02-18T15:33:50.756662Z",
"url": "https://files.pythonhosted.org/packages/61/16/0a77e92e7cb93a13f9e315147326aa0d3f6d5f2fef23198090c4e67228bc/pmemo-0.4.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-18 15:33:50",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Asugawara",
"github_project": "pmemo",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "pmemo"
}
