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
|
pyOCD Developers' Guide
=======================
PyOCD developers are recommended to setup a working environment using
[virtualenv](https://virtualenv.pypa.io/en/latest/). After cloning
the code, you can setup a virtualenv and install the pyOCD
dependencies for the current platform by following the detailed steps below.
## Setup
Install the necessary tools listed below. Skip any step where a compatible tool already exists.
* [Install Python](https://www.python.org/downloads/). Version 3.6.0 or above is preferred, while version 2.7.9 or above is also supported. Add to PATH.
* [Install Git](https://git-scm.com/downloads). Add to PATH.
* [Install virtualenv](https://virtualenv.pypa.io/en/latest/) in your global Python installation, eg: `pip install virtualenv`
## Steps
**Step 1.** Get the sources and create a virtual environment
```
$ git clone https://github.com/mbedmicro/pyOCD
$ cd pyOCD
$ virtualenv venv
```
You may wish to create two virtual environments, for both Python 2.7 and 3.x.
```
$ python2 -mvirtualenv venv2
$ python3 -mvirtualenv venv3
```
**Step 2.** Activate virtual environment
Activate your virtualenv and install the PyOCD dependencies for the current platform by doing
the following.
Linux or Mac:
```
$ source venv/bin/activate
$ pip install -r dev-requirements.txt
```
Windows:
```
$ venv\Scripts\activate
$ pip install -r dev-requirements.txt
```
**Step 3.** Develop
See the [porting guide](ADDING_NEW_TARGETS.md) for how to add new devices. Of course, we welcome
all improvements and changes. See the [contributor statement](../CONTRIBUTING.md) for some guidelines.
**Step 4.** Test
To run the unit tests, you can execute the following.
```
$ pytest
```
To get code coverage results, do the following:
```
$ pytest --cov-report=html --cov=pyocd
$ open htmlcov/index.html
```
The automated test suite also needs to be run:
```
$ cd test
$ python ./automated_test.py
```
**Step 5.** Pull request
Once you are satisfied with your changes and all automated tests pass, please create a
[new pull request](https://github.com/mbedmicro/pyOCD/pull/new/master) on GitHub to share your work.
Pull requests should be made once a changeset is [rebased onto Master](https://www.atlassian.com/git/tutorials/merging-vs-rebasing/workflow-walkthrough).
|
