mirror of https://github.com/onionshare/onionshare.git synced 2024-12-25 23:39:43 -05:00

History

Micah Lee 654611f1e4 Write macOS package script, to codesign child binaries		2020-11-04 17:34:00 -08:00
..
include/site/python3.8/greenlet	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
install	Write macOS package script, to codesign child binaries	2020-11-04 17:34:00 -08:00
screenshots	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
scripts	Make OnionShare briefcase work in macOS	2020-11-04 15:57:14 -08:00
src	Manually make close tab buttons in macOS, because PySide2 is not showing the button on its own	2020-11-04 16:08:11 -08:00
tests	Load onionshare_cli from source tree instead of pip dependency, and start making tests work with PySide2	2020-10-14 20:17:08 -07:00
.gitignore	Move docs back to root, move onionshare_gui into briefcase app, and make modifications so briefcase app will work	2020-10-13 17:28:54 -07:00
pyproject.toml	Make onionshare_cli an actual dependency of the GUI version	2020-10-15 16:30:30 -07: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

README.md

OnionShare Desktop

Building OnionShare

Start by getting the source code and changing to the desktop folder:

git clone https://github.com/micahflee/onionshare.git
cd onionshare/desktop

Install platform-specific dependencies

Linux

If you're using Linux, install tor and obfs4proxy from either the official Debian repository, or from your package manager.

macOS

Download and install Python 3.8.6 from https://www.python.org/downloads/release/python-386/. I downloaded python-3.8.6-macosx10.9.pkg. (You may need to also run /Applications/Python\ 3.8/Install\ Certificates.command.)

Install some python dependencies:

pip3 install --user poetry requests

Download Tor Browser and extract the binaries:

./scripts/get-tor-osx.py

Windows

These instructions include adding folders to the path in Windows. To do this, go to Start and type "advanced system settings", and open "View advanced system settings" in the Control Panel. Click Environment Variables. Under "System variables" double-click on Path. From there you can add and remove folders that are available in the PATH.

Download Python 3.8.6, 32-bit (x86) from https://www.python.org/downloads/release/python-386/. I downloaded python-3.8.6.exe. When installing it, make sure to check the "Add Python 3.8 to PATH" checkbox on the first page of the installer.

Download and install 7-Zip from http://www.7-zip.org/download.html. I downloaded 7z1900.exe. Add C:\Program Files (x86)\7-Zip to your path.

Download Tor Browser and extract the binaries:

pip install requests
python scripts\get-tor-windows.py

Prepare the code

In order to work with the desktop app, you'll need to build a wheel of the CLI package first, and copy it into the desktop folder:

cd ../cli
poetry install
poetry build
cp dist/onionshare_cli-*.whl ../desktop
cd ../desktop

OnionShare uses Briefcase.

Install Briefcase dependencies by following these instructions.

Now create and/or activate a virtual environment.

Linux and macOS

python3 -m venv venv
. venv/bin/activate

Windows

python -m venv venv
venv\Scripts\activate.bat

While your virtual environment is active, install briefcase from pip.

pip install briefcase

Run OnionShare from the source tree like this:

briefcase dev -d

Running tests

Install these packages inside your virtual environment:

pip install pytest pytest-briefcase pytest-faulthandler pytest-qt

Then run the tests:

./tests/run.sh

If you want to run tests while hiding the GUI, you must have the xvfb package installed, and then:

xvfb-run ./tests/run.sh