Skip to content

Commit 3576b65

Browse files
committed
Fixed missing s to password in login and updated readme
1 parent e6475bf commit 3576b65

File tree

2 files changed

+32
-5
lines changed

2 files changed

+32
-5
lines changed

README.md

Lines changed: 31 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,33 @@
11
# Looking for contributors
22

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
25+
containers will shutdown after the tests finish.
26+
27+
```
28+
docker-compose -f docker/v93/docker-compose.yml build
29+
docker-compose -f docker/v93/docker-compose.yml up --abort-on-container-exit
30+
```
431

532
# pyapi-gitlab
633

@@ -15,23 +42,23 @@ pyapi-gitlab is a python wrapper for the [Gitlab API](https://github.com/gitlabh
1542
[![Docs](https://readthedocs.org/projects/pyapi-gitlab/badge/?version=latest)](http://pyapi-gitlab.readthedocs.org/)
1643

1744

18-
1945
## Requirements
2046

2147
- requests
2248

2349

2450
## Naming convention
2551

26-
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.
2754

2855
## Installation
2956

3057
```bash
3158
pip install pyapi-gitlab
3259
```
3360

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
3562

3663

3764
# Versions tested

gitlab/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -173,7 +173,7 @@ def login(self, email=None, password=None, user=None):
173173
:raise: ValueError
174174
"""
175175
if user is not None:
176-
data = {'login': user, 'pasword': password}
176+
data = {'login': user, 'password': password}
177177
elif email is not None:
178178
data = {'email': email, 'password': password}
179179
else:

0 commit comments

Comments
 (0)