1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
|
.. _devenv:
Setting a Development Environment
=================================
Convenience script
------------------
There is an automated script that runs, sequentially, all the commands in the
section below. In debian-based systems, you can get a fully working development
environment with::
make dev-bootstrap
To activate the freshly created virtualenv the next time, you must use `pew`_::
pew workon bitmask
.. note:: the bootstrap script is, at the moment, quite opinionated. for
instance, it installs and depends on pew, it checks out the
bitmask-dev repo under ~/leap folder, and it assumes you are using
zsh. if you think it should allow more freedom of choices, feel free
to open a pull request.
.. _`pew`: https://pypi.python.org/pypi/pew
Manual instructions
-------------------
Install the system-wide dependencies. For debian-based systems::
sudo apt install build-essential python-dev python-virtualenv \
libsqlcipher-dev libssl-dev libffi-dev \
python-pyqt5 python-pyqt5.qtwebengine/
If you are going to be running tests that involve creating a lot of OpenPGP
keys, and specially in vms, the following is also recommended to speed up
things::
sudo apt install haveged
Clone the repo. The master branch has the latest code::
git clone https://0xacab.org/leap/bitmask-dev
cd bitmask-dev
Create a virtualenv and activate it::
virtualenv venv
source venv/bin/activate
By the way, if you plan to get into heavy development, you might want to
consider using something like `pew`_, instead of the plain virtualenv.
Now you should be able to install all the bitmask dependencies::
make dev-latest-all
You can also install some dependencies that are going to be useful during
development::
pip install -r pkg/requirements-dev.pip
What next?
-----------
Check out the Bitmask Architecture.
|
