Skip to content

Commit e0016f6

Browse files
committed
Python: CG trace: Mention adding projects in README
1 parent aca703e commit e0016f6

File tree

1 file changed

+20
-1
lines changed
  • python/tools/recorded-call-graph-metrics

1 file changed

+20
-1
lines changed

python/tools/recorded-call-graph-metrics/README.md

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Number of calls recorded vary a little from run to run. I have not been able to
1010

1111
## Running against real projects
1212

13-
Currently it's possible to gather metrics from traced runs against two projects (defined in [projects.json](./projects.json)): `youtube-dl` and `wcwidth`.
13+
Currently it's possible to gather metrics from traced runs of the standard test suite of a few projects (defined in [projects.json](./projects.json)): `youtube-dl`, `wcwidth`, and `flask`.
1414

1515
To run against all projects, use
1616

@@ -23,6 +23,25 @@ To view the results, use
2323
$ head -n 100 projects/*/Metrics.txt
2424
```
2525

26+
### Expanding set of projects
27+
28+
It should be fairly straight forward to expand the set of projects. Most projects use `tox` for running their tests against multiple python versions. I didn't look into any kind of integration, but have manually picked out the instructions required to get going.
29+
30+
As an example, compare the [`tox.ini`](https://github.com/pallets/flask/blob/21c3df31de4bc2f838c945bd37d185210d9bab1a/tox.ini) file from flask with the configuration
31+
32+
```json
33+
"flask": {
34+
"repo": "https://github.com/pallets/flask.git",
35+
"sha": "21c3df31de4bc2f838c945bd37d185210d9bab1a",
36+
"module_command": "pytest -c /dev/null tests examples",
37+
"setup": [
38+
"pip install -r requirements/tests.txt",
39+
"pip install -q -e examples/tutorial[test]",
40+
"pip install -q -e examples/javascript[test]"
41+
]
42+
}
43+
```
44+
2645
## Local development
2746

2847
### Setup

0 commit comments

Comments
 (0)