File: CONTRIBUTING.md

package info (click to toggle)
pyinfra 0.2.2+git20161227.ec708ef-1
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 11,804 kB
  • ctags: 677
  • sloc: python: 5,944; sh: 71; makefile: 11
file content (33 lines) | stat: -rw-r--r-- 832 bytes parent folder | download
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
# Contributing to pyinfra

Third party pull requests help expand pyinfra's functionality and are essential to it's continued growth. This guide should help get you started adding additional modules/facts to pyinfra.


## Dev setup

```
# Create a virtualenv
virtualenv /path/to/venv

# Clone the repo
git clone git@github.com:Fizzadar/pyinfra.git

# Install the package in "development mode"
pip install -e .
```


## Guides

+ [How to write operations](https://pyinfra.readthedocs.io/page/api/operations.html)
+ [How to write facts](https://pyinfra.readthedocs.io/page/api/facts.html)
+ [API reference](https://pyinfra.readthedocs.io/page/api/reference.html)


## Code

+ Always add tests for operations/facts
+ Keep code style consistent:
    - ~90 character lines
    - no hanging indents
    - single quotes everywhere possible