Skip to main content

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.

Project description

image PyPI PyPI - Python Version GitHub

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

$ 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
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.

License

pmemo is released under the MIT License. See LICENSE for additional details.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pmemo-0.4.0.tar.gz (15.0 kB view details)

Uploaded Source

Built Distribution

pmemo-0.4.0-py3-none-any.whl (18.5 kB view details)

Uploaded Python 3

File details

Details for the file pmemo-0.4.0.tar.gz.

File metadata

  • Download URL: pmemo-0.4.0.tar.gz
  • Upload date:
  • Size: 15.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.7.1 CPython/3.9.18 Linux/6.2.0-1019-azure

File hashes

Hashes for pmemo-0.4.0.tar.gz
Algorithm Hash digest
SHA256 cdf94608cd4b532a856c8ea19b3591b85af2995e8f60e497d08f07a03850a76f
MD5 278d1e3a7723b114ec992d61710a6eec
BLAKE2b-256 61160a77e92e7cb93a13f9e315147326aa0d3f6d5f2fef23198090c4e67228bc

See more details on using hashes here.

File details

Details for the file pmemo-0.4.0-py3-none-any.whl.

File metadata

  • Download URL: pmemo-0.4.0-py3-none-any.whl
  • Upload date:
  • Size: 18.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.7.1 CPython/3.9.18 Linux/6.2.0-1019-azure

File hashes

Hashes for pmemo-0.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 1240a95ee42efcc92f22f18bda9ddfc566dbc3784915d0f087ca69964dbf45ee
MD5 f7f42e0b0a0179dabad8eba356115cd5
BLAKE2b-256 e3782194388f5a877ed50783281b0f9cd62cb0c3e2834df81f36ed0a11542270

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page