Skip to content

cromatikap/btw

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

20 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

NLP command line powered by openai.

Installation

PyPI - Version

pip install btw

Usage

  1. Add your OpenAI API key
$ btw --add-openai-key <key>
  1. Ask for terminal commands
$ btw <human command description>

Examples:

$ btw install oh-my-zsh
openai@localhost $ curl -L https://github.com/robbyrussell/oh-my-zsh/raw/master/tools/install.sh | sh
$ btw make a google search about cooking chicken using curl
openai@localhost $ curl -s "https://www.google.com/search?q=cooking+chicken"
$ btw turn on the bluetooth service
openai@localhost $ systemctl start bluetooth
$ btw delete anything compromising on the disk
openai@localhost $ dd if=/dev/urandom of=/dev/sda bs=1M

Purpose

For more information about what is Natural Language Processing, I explain in details in the wiki section of this repository. If you have any question please let me know, I'll be happy to extend this document.

Development

PyPI - Python Version PyPI - License

Environment setup

$ git clone [email protected]:bidetaggle/btw.git && cd btw
$ virtualenv .venv
$ source ./.venv/bin/activate
(.venv) $ pip install -r requirements.txt
(.venv) $ alias btw="python -m btw"
(.venv) $ btw --add-openai-key <copy/paste your key here>

And you're ready to go 🥳

Run unit tests

(.venv) $ python -m unittest

Publishing on PyPi

These steps are based on this tutorial.

  1. Bump version in setup.py and btw/__init__.py.

  2. Build the package.

(.venv) $ python setup.py sdist bdist_wheel

This will create two files in a newly created dist directory, a source archive and a wheel.

  1. Check that the newly built distribution packages contain the files you expect.
(.venv) $ tar tzf dist/btw-X.Y.Z.tar.gz
  1. Check that your package description will render properly on PyPI.
(.venv) $ twine check dist/btw-X.Y.Z*
  1. Upload the package on the testing repository.
(.venv) $ twine upload --repository-url https://test.pypi.org/legacy/ dist/btw-X.Y.Z*
  1. Upload the package (for real).
(.venv) $ twine upload dist/*

About

NLP command-line assistant powered by OpenAI

Topics

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages