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
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
|
# Developing in a Virtualenv
For development purposes, Plaso can be installed using virtualenv.
**Note that this is intended for development use only, and if you aren't
comfortable debugging package installation, this is not for you.**
## Fedora
### Install virtualenv
To install virtualenv on Fedora (or equivalent) run:
```
sudo dnf install python-virtualenv
```
### Installing build dependencies
**TODO add more text**
## Ubuntu
### Installing virtualenv
To install virtualenv on Ubuntu (or equivalent) run:
```
sudo apt-get install python-virtualenv
```
### Installing build dependencies
**TODO add more text**
```
sudo apt-get install libyaml-dev liblzma-dev
```
## MacOS
### Installing virtualenv
If you have `pip` setup on your system, you can install
`virtualenv` using:
```bash
pip install virtualenv
```
To install `pip`, either install a version of Python 3.6+ or,
using [homebrew](https://brew.sh/), run:
```bash
brew install python@3
```
### Installing build dependencies
**TODO**
The `pycrypto` dependency requires the `gmp` library. This is
installable with homebrew:
```bash
brew install gmp
```
Once setup, we need to add the paths for the system to locate
the `gmp` library. This is accomplished during the
`pip install -r requirements.txt` stage of the next section.
Before running the `pip install ...` command, please run:
```bash
export "CFLAGS=-I/usr/local/include -L/usr/local/lib"
```
## Setting up Plaso in a virtualenv
1. Create a virtualenv called 'plasoenv' `virtualenv plasoenv`
1. Activate the virtualenv: `source ./plasoenv/bin/activate`
1. Update pip (Note that using pip outside virtualenv is not recommended as it
ignores your systems package manager.): `pip install --upgrade pip`
1. Install the Python requirements
```bash
# Where 'plaso' is your local Plaso source directory
cd plaso
curl -O https://raw.githubusercontent.com/log2timeline/plaso/master/requirements.txt
pip install -r requirements.txt
```
1. Once you finish you development session, deactivate virtualenv: `deactivate`
|
