summaryrefslogtreecommitdiffstats
path: root/README.md
blob: a3ea8aa46f3b4bc89b9c272ee37429f962c3de65 (plain)
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
# Python-apt is a wrapper to use features of apt from python.

It contains the following modules:

## C++ Wrapper:

* apt_pkg - access to libapt-pkg (wrapper to the lowlevel c++ code)
* apt_inst - access to libapt-inst (wrapper to the lowlevel c++ code)

## Python module:

* apt - high level python interface build on top of apt_pkg, apt_inst
* aptsources - high level manipulation of sources.list


# Development

## Building

To build python-apt run:
```
$ python setup.py build
```
You may need to install the build-dependencies via:
```
$ sudo apt build-dep ./
```
first.

## Running the tests

Run the tests with:
```
$ python tests/test_all.py
$ python3 tests/test_all.py
```

## Running mypy:

To check if the "apt" python module is mypy clean, run:
```
$ MYPYPATH=./typehinting/ mypy ./apt
```

To use the annotation with your source code, run:
```
$ MYPYPATH=/usr/lib/python3/dist-packages/apt mypy ./my-program
```
(adjust from python3 to python2.7 if you run there).