onionshare/BUILD.md

108 lines
4.1 KiB
Markdown
Raw Normal View History

2014-06-10 13:31:19 -04:00
# Building OnionShare
## GNU/Linux
Start by getting a copy of the source code:
2014-06-24 14:37:13 -04:00
```sh
git clone https://github.com/micahflee/onionshare.git
cd onionshare
```
*For .deb-based distros (like Debian, Ubuntu, Linux Mint):*
Note that python-stem appears in Debian wheezy and newer (so by extension Tails 1.1 and newer), and it appears in Ubuntu 13.10 and newer. Older versions of Debian and Ubuntu aren't supported.
2014-06-24 14:37:13 -04:00
```sh
sudo apt-get install -y build-essential fakeroot python-all python-stdeb python-flask python-stem python-qt4
./build_deb.sh
sudo dpkg -i deb_dist/onionshare_*.deb
```
*For .rpm-based distros (Red Hat, Fedora, CentOS):*
2014-06-24 14:37:13 -04:00
```sh
sudo yum install -y rpm-build python-flask python-stem pyqt4
./build_rpm.sh
sudo yum install -y dist/onionshare-*.rpm
```
2014-06-10 13:31:19 -04:00
## Mac OS X
To install the right dependencies, you need homebrew and pip installed on your Mac. Follow instructions at http://brew.sh/ to install homebrew, and run `sudo easy_install pip` to install pip.
The first time you're setting up your dev environment:
2014-06-24 14:37:13 -04:00
```sh
git clone https://github.com/micahflee/onionshare.git
cd onionshare
echo export PYTHONPATH=\$PYTHONPATH:/usr/local/lib/python2.7/site-packages/ >> ~/.profile
source ~/.profile
brew install qt4 pyqt
sudo pip install virtualenv
virtualenv env
. env/bin/activate
2014-06-25 17:42:39 -04:00
pip install flask stem pyinstaller
2014-06-24 14:37:13 -04:00
```
2014-06-10 13:31:19 -04:00
Each time you start work:
2014-06-10 13:31:19 -04:00
2014-06-24 14:37:13 -04:00
```sh
. env/bin/activate
```
2014-06-10 13:31:19 -04:00
To build the .app:
2014-06-11 00:10:37 -04:00
2014-06-24 14:37:13 -04:00
```sh
2014-06-25 17:42:39 -04:00
pyinstaller -w -y setup/onionshare-osx.spec
2014-06-24 14:37:13 -04:00
```
2014-06-11 00:10:37 -04:00
Now you should have `dist/OnionShare.app`.
2014-06-11 00:10:37 -04:00
To build a .dmg (this script builds the .app for you):
```sh
setup/build_dmg.sh
```
## Windows
2014-06-10 13:31:19 -04:00
The first time you're setting up your dev environment:
* Download and install the latest python 2.7 from https://www.python.org/downloads/ -- make sure you install the 32-bit version.
* Right click on Computer, go to Properties. Click "Advanced system settings". Click Environment Variables. Under "System variables" double-click on Path to edit it. Add `;C:\Python27;C:\Python27\Scripts` to the end. Now you can just type `python` to run python scripts in the command prompt.
* Go to https://pip.pypa.io/en/latest/installing.html. Right-click on `get-pip.py` and Save Link As, and save it to your home folder.
* Open `cmd.exe` as an administrator. Type: `python get-pip.py`. Now you can use `pip` to install packages.
* Open a command prompt and type: `pip install flask stem pyinstaller`
* Go to http://www.riverbankcomputing.com/software/pyqt/download and download the latest PyQt4 for Windows for python 2.7, 32-bit (I downloaded `PyQt4-4.11-gpl-Py2.7-Qt4.8.6-x32.exe`), then install it.
* Go to http://sourceforge.net/projects/pywin32/ and download and install the latest 32-bit pywin32 binary for python 2.7. I downloaded `pywin32-219.win32-py2.7.exe`.
2014-06-26 15:59:32 -04:00
* Download and install the [Microsoft Visual C++ 2008 Redistributable Package (x86)](http://www.microsoft.com/en-us/download/details.aspx?id=29).
To make a .exe:
* Open a command prompt, cd into the onionshare directory, and type: `pyinstaller -y setup\onionshare-win.spec`. Inside the `dist` folder there will be a folder called `onionshare` with `onionshare.exe` in it.
If you want to build the installer:
* Go to http://nsis.sourceforge.net/Download and download the latest NSIS. I downloaded `nsis-3.0b0-setup.exe`.
* Right click on Computer, go to Properties. Click "Advanced system settings". Click Environment Variables. Under "System variables" double-click on Path to edit it. Add `;C:\Program Files (x86)\NSIS` to the end. Now you can just type `makensisw [script]` to build an installer.
To build the installer:
2014-06-26 16:09:08 -04:00
* Follow the steps above until to make the .exe. You should have a folder called `dist\onionshare` with a bunch of files inside of it, including `onionshare.exe`. Run `onionshare.exe` once before you build the installer, to compile all the `.py` files into `.pyc` files.
* Open a command prompt, cd into the onionshare directory, and type: `makensisw setup\onionshare.nsi`. You'll find the installer, `OnionShare_Setup.exe`, inside the `dist` folder.
## Tests
OnionShare includes [nose](https://nose.readthedocs.org/en/latest/) unit tests. First,
2014-06-24 14:37:13 -04:00
```sh
sudo pip install nose
```
To run the tests:
2014-06-24 14:37:13 -04:00
```sh
nosetests test
```