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.6.tar.gz (5.8 kB view details)

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: nlpip-0.1.6.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.6.tar.gz
Algorithm Hash digest
SHA256 054de198454d607a7c4e6ddea629db439ec37b96aceb27a565f6f52210af67b9
MD5 6eb6ccaa63e9c558d6dd67b4790f2664
BLAKE2b-256 0fbd8dfab1f0bae2ac69a27d00b556efffbdd18e5d19ce6c9eba80fea5ba5a41

See more details on using hashes here.

File details

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

File metadata

  • Download URL: nlpip-0.1.6-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.6-py3-none-any.whl
Algorithm Hash digest
SHA256 a634bbcbd5210571d89f54484d11329da8a6ea5b3058dca2b6c79a9bf67a0c51
MD5 010d29016f482f2ca4b1d24b30b05165
BLAKE2b-256 e9bb487d482f910ea461034f85a72e2b84f098ed977b18924f1d5c35b8850321

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