Add desktop documentation about building CLI wheel, and make CircleCI tests build CLI wheel first as well

This commit is contained in:
Micah Lee 2020-11-01 10:13:58 -08:00
parent 7ece466d82
commit 208d615ad0
No known key found for this signature in database
GPG key ID: 403C2657CD994F73
2 changed files with 23 additions and 16 deletions

View file

@ -50,6 +50,10 @@ jobs:
command: | command: |
sudo apt-get update sudo apt-get update
sudo apt-get install -y xvfb tor obfs4proxy gcc python3-dev sudo apt-get install -y xvfb tor obfs4proxy gcc python3-dev
cd ~/repo/cli
poetry install
poetry build
cp dist/onionshare_cli-*.whl ~/repo/desktop
cd ~/repo/desktop cd ~/repo/desktop
pip install briefcase pytest pytest-briefcase pytest-faulthandler pytest-qt pip install briefcase pytest pytest-briefcase pytest-faulthandler pytest-qt
pip install $(python -c 'import toml; print(" ".join(toml.loads(open("pyproject.toml").read())["tool"]["briefcase"]["app"]["onionshare"]["requires"]))') pip install $(python -c 'import toml; print(" ".join(toml.loads(open("pyproject.toml").read())["tool"]["briefcase"]["app"]["onionshare"]["requires"]))')

View file

@ -34,7 +34,15 @@ python scripts\get-tor-windows.py
### Prepare the code ### Prepare the code
#### All platforms 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:
```sh
cd ../cli
poetry install
poetry build
cp dist/onionshare_cli-*.whl ../desktop
cd ../desktop
```
OnionShare uses [Briefcase](https://briefcase.readthedocs.io/en/latest/). OnionShare uses [Briefcase](https://briefcase.readthedocs.io/en/latest/).
@ -42,22 +50,17 @@ Install Briefcase dependencies by following [these instructions](https://docs.be
Now create and/or activate a virtual environment. Now create and/or activate a virtual environment.
#### Linux and macOS * Linux and macOS
``` ```
python3 -m venv venv python3 -m venv venv
. venv/bin/activate . venv/bin/activate
``` ```
* Windows
#### Windows
``` ```
python -m venv venv python -m venv venv
venv\Scripts\activate.bat venv\Scripts\activate.bat
``` ```
#### All platforms
While your virtual environment is active, install briefcase from pip. While your virtual environment is active, install briefcase from pip.
``` ```