Metadata-Version: 2.1
Name: btw
Version: 1.0.7
Summary: By The Way is an NLP command line powered by openai
Home-page: https://github.com/bidetaggle/btw
Author: bidetaggle
Author-email: bidetaggle@gmail.com
License: MIT
Description: 
        
        <h1 align="center">
          <img src="https://raw.githubusercontent.com/bidetaggle/btw/master/assets/bytheway.png" />
        </h1>
        
        <h2 align="center">
          NLP command line powered by openai.
          <br /><br />
          <img src="https://raw.githubusercontent.com/bidetaggle/btw/master/assets/bytheway2.gif" />
        </h2>
        
        ## Usage
        
        1. Add your OpenAI API key
        
        ```
        $ btw --add-openai-key <key>
        ```
        
        2. 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](https://github.com/bidetaggle/btw/wiki/Purpose) 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](https://realpython.com/pypi-publish-python-package/#building-your-package).
        
        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.
        
        3. Check that the newly built distribution packages contain the files you expect.
        
        ```
        (.venv) $ tar tzf dist/btw-X.Y.Z.tar.gz
        ```
        
        4. Check that your package description will render properly on PyPI.
        
        ```
        (.venv) $ twine check dist/btw-X.Y.Z*
        ```
        
        5. Upload the package on the testing repository.
        
        ```
        (.venv) $ twine upload --repository-url https://test.pypi.org/legacy/ dist/btw-X.Y.Z*
        ```
        
        6. Upload the package (for real).
        
        ```
        (.venv) $ twine upload dist/*
        ```
        
Platform: UNKNOWN
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Description-Content-Type: text/markdown
