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

Uploaded Source

Built Distribution

nlpip-0.1.4-py3-none-any.whl (5.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: nlpip-0.1.4.tar.gz
  • Upload date:
  • Size: 5.7 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.4.tar.gz
Algorithm Hash digest
SHA256 da200e70a6212b6720fd288ed6f37aca6349a79156bc38b8dfd2091301b5129e
MD5 ca6b758694a97d158f74f91733eebb63
BLAKE2b-256 6340c8a995e320941c677dd3d3da1c7ada126a968528b4137a55d0f08e538200

See more details on using hashes here.

File details

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

File metadata

  • Download URL: nlpip-0.1.4-py3-none-any.whl
  • Upload date:
  • Size: 5.7 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.4-py3-none-any.whl
Algorithm Hash digest
SHA256 3bd6922ce43510afc1374dff1ddf8dba65458769414aa84b91a203c2f4289d26
MD5 ff4ca22ec5879293a37aa19ca9fd8935
BLAKE2b-256 e7b9c5a1df9c12e833cfcff7ba2fea86ad10534246e62390ce970dd9133e257b

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