You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+31-4Lines changed: 31 additions & 4 deletions
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,33 @@
1
1
# Looking for contributors
2
2
3
-
If you are interested in contributing to this wrapper we ask that all pull requests have an open issue that and they be referenced. We also ask that you submit unit tests for your changes to make sure there are no regressions.
3
+
If you are interested in contributing to this wrapper we ask that all pull requests have an open issue that and they
4
+
be referenced. We also ask that you submit unit tests for your changes to make sure there are no regressions.
5
+
6
+
## Pull Requests
7
+
8
+
We are currently working on getting pyapi-gitlab to 100% coverage in both unittests and integration tests. Well the
9
+
integration testing is not fully flushed out yet the unittests are so we ask that all new pull requests have unittests
10
+
with them.
11
+
12
+
## Setting up for development
13
+
14
+
If you wish to setup your system for development you will need to install the test requirements and we ask that you
15
+
consider docker for integration testing.
16
+
17
+
To install the test requirements you will need to run the following command `pip install -Ur test-requirements.txt`.
18
+
This will install both the `requirements.txt` and the `test-requirements.txt`.
19
+
20
+
To run the test simply run `./cov` from the project root directory.
21
+
22
+
To review the cover open the `index.html` file in the `coverage_html_report`.
23
+
24
+
To run the integration test run the commands below. This will build the docker containers and then start them. The
pyapi-gitlab has its own versioning in which the 2 first numbers indicates the Gitlab version that its supported for that library. a 7.5 version means that its compatible with the Gitlab 7.5 and lower API versions.
52
+
pyapi-gitlab has its own versioning in which the 2 first numbers indicates the Gitlab version that its supported for
53
+
that library. a 7.5 version means that its compatible with the Gitlab 7.5 and lower API versions.
27
54
28
55
## Installation
29
56
30
57
```bash
31
58
pip install pyapi-gitlab
32
59
```
33
60
34
-
pyapi-gitlab supports python version 2.6, 2.7, 3.3 and 3.4
61
+
pyapi-gitlab supports python version 2.7, 3.3, 3.4, 3.5, 3.5-dev, 3.6, 3.6-dev, 3.7-dev, and the nightly build
0 commit comments