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
|
# Development
::: tip NOTE
The following is only necessary if you want to contribute features
to EagerPy. As a user of EagerPy, you can just do a normal
[installation](./getting-started).
:::
## Installation
First clone the repsository using `git`:
```bash
git clone https://github.com/jonasrauber/eagerpy
```
You can then do an editable installation using `pip -e`:
```bash
cd eagerpy
pip3 install -e .
```
::: tip
Create a new branch for each new feature or contribution.
This will be necessary to open a pull request later.
:::
## Coding Style
We follow the [PEP 8 Style Guide for Python Code](https://www.python.org/dev/peps/pep-0008/).
We use [black](https://github.com/psf/black) for automatic code formatting.
In addition, we use [flake8](https://flake8.pycqa.org/en/latest/) to detect
certain PEP 8 violations.
::: tip
Have a look at the `Makefile`. It contains many useful commands, e.g. `make black` or `make flake8`.
:::
## Type annotions and MyPy
EagerPy uses Python type annotations introduced in [PEP 484](https://www.python.org/dev/peps/pep-0484/).
We use [mypy](http://mypy-lang.org) for static type checking with relatively
strict settings. All code in EagerPy has to be type annotated.
We recommend to run MyPy or a comparable type checker automatically in your
editor (e.g. VIM) or IDE (e.g. PyCharm). You can also run MyPy from the
command line:
```bash
make mypy # run this in the root folder that contains the Makefile
```
::: tip NOTE
`__init__` methods should not have return type annotations unless
they have no type annotated arguments (i.e. only `self`), in which case
the return type of `__init__` should be specifed as `None`.
:::
## Creating a pull request on GitHub
First, fork the [EagerPy repository on GitHub](https://github.com/jonasrauber/eagerpy).
Then, add the fork to your local GitHub repository:
```bash
git remote add fork https://github.com/YOUR USERNAME/eagerpy
```
Finally, push your new branch to GitHub and open a pull request.
## Release Process
EagerPy currently follows a rapid release process. Whenever non-trivial
changes have been made, the documentation and tests have been updated,
and all tests pass, a new version can be released. To reduce the barrier,
this is simply done by creating a new release on GitHub. This automatically
triggers a [GitHub Action](https://github.com/jonasrauber/eagerpy/actions)
that builds the package and publishes the new version on the Python Package
Index [PyPI](https://pypi.org/project/eagerpy/). The latest version can
thus be simply installed using `pip`:
|
