read the docs for changes. Fixes pyapi-gitlab#14

Itxaka · Itxaka · commit 99ac7dac6f77 · 2013-09-12T09:53:20.000+02:00
diff --git a/docs/index.rst b/docs/index.rst
@@ -26,9 +26,10 @@ Then we need to authenticate to our Gitlab instance. There is 2 ways of doing th
 Authenticating via user/password
 ==================================
 
-First create the instance passing the gitlab server as parameter::
+First create the instance passing the gitlab server as parameter, You can also pass the gitlab backend version as there are some differences
+between 5 and 6 (One example, when creating projects you cna make them public on gitlab 6, gitlab 5 doesn't have that option) default version is 5::
 
-   git = gitlab.Gitlab("our_gitlab_host")
+   git = gitlab.Gitlab("our_gitlab_host","5")
 
 Then call the login() method::
 
@@ -110,9 +111,14 @@ Get project events::
 
    git.getProjectEvents(project_id)
 
-Create a new project::
+Create a new project
+If you are using version 6 you can pass an extra "public" argument which makes the project public.
+Please note that Gitlab 5 doesn't have this option and you have to explicity declare your version of gitlab (See the start of the docs to find how)::
 
-   git.createProject("test project number 1")
+   git.createProject(name, description="", default_branch="",
+                      issues_enabled="", wall_enabled="",
+                      merge_requests_enabled="", wiki_enabled="",
+                      snippets_enabled="", public="")
 
 List project members::
 
diff --git a/gitlab/__init__.py b/gitlab/__init__.py
@@ -11,7 +11,7 @@
 
 
 class Gitlab(object):
-    def __init__(self, host, token=""):
+    def __init__(self, host, token="", version=5):
         if token != "":
             self.token = token
             self.headers = {"PRIVATE-TOKEN": self.token}
@@ -20,6 +20,7 @@ def __init__(self, host, token=""):
         self.users_url = self.host + "/api/v3/users"
         self.keys_url = self.host + "/api/v3/user/keys"
         self.groups_url = self.host + "/api/v3/groups"
+        self.version = version
 
     def login(self, email, password):
         data = {"email": email, "password": password}
@@ -252,7 +253,7 @@ def getProjectEvents(self, id_):
     def createProject(self, name, description="", default_branch="",
                       issues_enabled="", wall_enabled="",
                       merge_requests_enabled="", wiki_enabled="",
-                      snippets_enabled=""):
+                      snippets_enabled="", public=""):
         """
         Create a project
         :param name: Obligatory
@@ -265,6 +266,11 @@ def createProject(self, name, description="", default_branch="",
                 "merge_requests_enabled": merge_requests_enabled,
                 "wiki_enabled": wiki_enabled,
                 "snippets_enabled": snippets_enabled}
+
+        # if gitlab is the new 6th version, there is a public option for the
+        # project creation
+        if self.version == 6:
+            data['public'] = public
         r = requests.post(self.projects_url, headers=self.headers, data=data)
         if r.status_code == 201:
             return json.loads(r.content)
