Skip to main content

A natural language based unix pipeline utility

Project description

nlpip - A natural language based unix pipeline utility

nlpip takes a text written in natural language as input, and performs a specified command also written in natural language, and then outputs the result in natural language.

Here's a demo:

screen recording

Installation

First, you need to install nlpip using pip:

pip install nlpip

Then, set your OpenAI's API key as an environment variable:

export OPENAI_API_KEY=WRITE_YOUR_KEY_HERE

How to use

nlpip or just nlp for short, provides following default commands:

  • keywords: Extract keywords from input text
  • poem: Write poem using input text
  • summarize: Summarize input text
  • sentiment: Analyze sentiment of input text

For example, if you want summarize input.txt and turn it into a poem, you can run the following command:

cat input.txt | nlp summarize | nlp poem

How to create a new command

To create a new command, you just need to create a text file containing the command in natural language. For example, if you want to create a command that translates input text into French, you can create a file named ~/.nlpip/prompts/fr.txt in with:

Translate into French

Then, you can run the following command:

echo Hello | nlp fr

And you will get the following output:

Bonjour

You may override default commands by creating a file with the same name in ~/.nlpip/prompts/.

Credit

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

nlpip-0.1.5.tar.gz (5.8 kB view details)

Uploaded Source

Built Distribution

nlpip-0.1.5-py3-none-any.whl (5.9 kB view details)

Uploaded Python 3

File details

Details for the file nlpip-0.1.5.tar.gz.

File metadata

  • Download URL: nlpip-0.1.5.tar.gz
  • Upload date:
  • Size: 5.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.0

File hashes

Hashes for nlpip-0.1.5.tar.gz
Algorithm Hash digest
SHA256 b83cc68992b4982e5bb60d8b179894640b6cbe9141276a5c7367f593308b2924
MD5 13e3b0614436eadb1c1cdfcd8aa78ec1
BLAKE2b-256 1c848b6446865b475829263e09cc2251e2a9b7d786be02a8a77188a129c982be

See more details on using hashes here.

File details

Details for the file nlpip-0.1.5-py3-none-any.whl.

File metadata

  • Download URL: nlpip-0.1.5-py3-none-any.whl
  • Upload date:
  • Size: 5.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.0

File hashes

Hashes for nlpip-0.1.5-py3-none-any.whl
Algorithm Hash digest
SHA256 b12ee165c507d55cb61df5c1508ebdc083a4647798b61c2017b8977ba85b5f77
MD5 d2211c9d12604d25b6de658eec129439
BLAKE2b-256 177933bef0f2513a95d2f225dfe4060316c64a903f2f6de4eccf6a75583619a3

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