onionshare/cli
Saptak S ac1557fc8f Forces socket io to use websocket instead of polling
SocketIO uses the last successful method of transport to communicate. But we
have eventlet in our dependency which allows for websocket, and we ideally
want communications to be over websocket. So specified the transport method
as websocket in socket io connect.
2020-11-10 19:57:51 +05:30
..
.circleci Add onionshare CLI to cli folder, move GUI to desktop folder, and start refactoring it to work with briefcase 2020-10-12 22:40:55 -07:00
onionshare_cli Forces socket io to use websocket instead of polling 2020-11-10 19:57:51 +05:30
tests Remove obsolete resource path tests 2020-11-08 14:51:45 -08:00
poetry.lock Add setuptools as a dependency for pkg_resources module, and update build scripts to properly delete last build 2020-11-09 18:36:31 -08:00
pyproject.toml Add setuptools as a dependency for pkg_resources module, and update build scripts to properly delete last build 2020-11-09 18:36:31 -08:00
README.md Write unified release documentation, move licenses into the root, and delete some unnecessary files from desktop/install 2020-11-04 16:51:48 -08:00
setup.py Version bump to 2.3.dev2, and update Linux installation in docs 2020-11-08 20:45:54 -08:00

                     @@@@@@@@@                      
                @@@@@@@@@@@@@@@@@@@                 
             @@@@@@@@@@@@@@@@@@@@@@@@@              
           @@@@@@@@@@@@@@@@@@@@@@@@@@@@@            
             @@@@@@@@@@@@@@@@@@@@@@@@@@@@@           ___        _               
               @@@@@@         @@@@@@@@@@@@@         / _ \      (_)              
         @@@@    @               @@@@@@@@@@@       | | | |_ __  _  ___  _ __    
       @@@@@@@@                   @@@@@@@@@@       | | | | '_ \| |/ _ \| '_ \   
     @@@@@@@@@@@@                  @@@@@@@@@@      \ \_/ / | | | | (_) | | | |  
   @@@@@@@@@@@@@@@@                 @@@@@@@@@       \___/|_| |_|_|\___/|_| |_|  
      @@@@@@@@@                 @@@@@@@@@@@@@@@@    _____ _                     
      @@@@@@@@@@                  @@@@@@@@@@@@     /  ___| |                    
       @@@@@@@@@@                   @@@@@@@@       \ `--.| |__   __ _ _ __ ___ 
       @@@@@@@@@@@               @    @@@@          `--. \ '_ \ / _` | '__/ _ \
        @@@@@@@@@@@@@         @@@@@@               /\__/ / | | | (_| | | |  __/
         @@@@@@@@@@@@@@@@@@@@@@@@@@@@@             \____/|_| |_|\__,_|_|  \___|
           @@@@@@@@@@@@@@@@@@@@@@@@@@@@@            
             @@@@@@@@@@@@@@@@@@@@@@@@@              
                @@@@@@@@@@@@@@@@@@@                 
                     @@@@@@@@@                      

Installing OnionShare CLI

First, make sure you have tor installed. In Linux, install it through your package manager. In macOS, install it with Homebrew: brew install tor.

Then install OnionShare CLI:

pip install onionshare-cli

Then run it with:

onionshare-cli --help

Developing OnionShare CLI

You must have python3 and poetry installed.

Install dependencies with poetry:

poetry install

To run from the source tree:

poetry run onionshare-cli

To run tests:

poetry run pytest -v ./tests

Build a wheel package

poetry build

This will create dist/onionshare_cli-$VERSION-py3-none-any.whl.