Skip to main content

NLP command line powered by openai.

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 "http://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.

Getting started

Requirements

  • python >= 3.8

Environment setup

$ git clone git@github.com: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/*

Metadata

Release files for btw 1.0.7

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for btw 1.0.7
File Size Uploaded Provenance Actions
btw-1.0.7.tar.gz 5.8 kB Without provenance Details for btw-1.0.7.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for btw 1.0.7
File Interpreter ABI Platform Actions
btw-1.0.7-py3-none-any.whl Python 3 none any Details for btw-1.0.7-py3-none-any.whl

Total release size: 13.6 kB

Release files / btw-1.0.7.tar.gz

Download URL btw-1.0.7.tar.gz
Size 5.8 kB
Tags Source
SHA-256 checksum
How to use checksums
df5625fcc256581299fde944003789a8591416c0bbc9ee5cfbf17a64bf726fa0
BLAKE2b-256 checksum
How to use checksums
3da9cbf13c8ab145544b2c3573cd2071e18053f99a0d61f163ba22f898581feb
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.4.1 importlib_metadata/4.5.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.0 CPython/3.8.7

Release files / btw-1.0.7-py3-none-any.whl

Download URL btw-1.0.7-py3-none-any.whl
Size 7.7 kB
Tags Python 3
SHA-256 checksum
How to use checksums
6784a9f6d7a1625715dd4f4ba69460484a1063f134a2e3fce32d29a6bedb45f1
BLAKE2b-256 checksum
How to use checksums
eb8e2137b3b9ae19e0523523fb701f008680e09008714c0beff2020ef5fefb9a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.4.1 importlib_metadata/4.5.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.0 CPython/3.8.7

Security for btw 1.0.7

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

1.0.7 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page