Renamed to gitea_client

richmahn · richmahn · commit 367d84335b0c · 2020-10-02T08:12:48.000-04:00
diff --git a/README.rst b/README.rst
@@ -1,25 +1,25 @@
 Master:
-  .. image:: https://travis-ci.org/unfoldingWord-dev/python-gogs-client.svg?branch=master
+  .. image:: https://travis-ci.org/unfoldingWord-dev/python-gitea-client.svg?branch=master
     :alt: Build Status
-    :target: https://travis-ci.org/unfoldingWord-dev/python-gogs-client
-  .. image:: https://coveralls.io/repos/github/unfoldingWord-dev/python-gogs-client/badge.svg?branch=master
+    :target: https://travis-ci.org/unfoldingWord-dev/python-gitea-client
+  .. image:: https://coveralls.io/repos/github/unfoldingWord-dev/python-gitea-client/badge.svg?branch=master
     :alt: Coverage
-    :target: https://coveralls.io/github/unfoldingWord-dev/python-gogs-client?branch=master
+    :target: https://coveralls.io/github/unfoldingWord-dev/python-gitea-client?branch=master
 
 Develop:
-  .. image:: https://travis-ci.org/unfoldingWord-dev/python-gogs-client.svg?branch=develop
+  .. image:: https://travis-ci.org/unfoldingWord-dev/python-gitea-client.svg?branch=develop
     :alt: Build Status
-    :target: https://travis-ci.org/unfoldingWord-dev/python-gogs-client
-  .. image:: https://coveralls.io/repos/github/unfoldingWord-dev/python-gogs-client/badge.svg?branch=develop
+    :target: https://travis-ci.org/unfoldingWord-dev/python-gitea-client
+  .. image:: https://coveralls.io/repos/github/unfoldingWord-dev/python-gitea-client/badge.svg?branch=develop
     :alt: Coverage
-    :target: https://coveralls.io/github/unfoldingWord-dev/python-gogs-client?branch=develop
+    :target: https://coveralls.io/github/unfoldingWord-dev/python-gitea-client?branch=develop
 
 
-python-gogs-client
+python-gitea-client
 ==================
 
-This is a Python client to Gogs servers. The easiest way to install is via ``pip``::
+This is a Python client to Gitea servers. The easiest way to install is via ``pip``::
 
-    $ pip install gogs_client
+    $ pip install gitea_client
 
-Documentation for the module can be found `here <http://pythonhosted.org/gogs-client/>`_.
+Documentation for the module can be found `here <http://pythonhosted.org/gitea-client/>`_.
diff --git a/docs/Makefile b/docs/Makefile
@@ -91,9 +91,9 @@ qthelp:
 	@echo
 	@echo "Build finished; now you can run "qcollectiongenerator" with the" \
 	      ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
-	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/gogs_client.qhcp"
+	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/gitea_client.qhcp"
 	@echo "To view the help file:"
-	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/gogs_client.qhc"
+	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/gitea_client.qhc"
 
 .PHONY: applehelp
 applehelp:
@@ -110,8 +110,8 @@ devhelp:
 	@echo
 	@echo "Build finished."
 	@echo "To view the help file:"
-	@echo "# mkdir -p $$HOME/.local/share/devhelp/gogs_client"
-	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/gogs_client"
+	@echo "# mkdir -p $$HOME/.local/share/devhelp/gitea_client"
+	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/gitea_client"
 	@echo "# devhelp"
 
 .PHONY: epub
diff --git a/gitea_client/__init__.py b/gitea_client/__init__.py
@@ -0,0 +1,4 @@
+from gitea_client.auth import Authentication, Token, UsernamePassword
+from gitea_client.entities import GogsUser, GogsRepo, GogsBranch, GogsCommit, GogsOrg, GogsTeam
+from gitea_client.interface import GogsApi, ApiFailure, NetworkFailure
+from gitea_client.updates import GogsUserUpdate, GogsHookUpdate
diff --git a/gitea_client/_implementation/__init__.py b/gitea_client/_implementation/__init__.py
diff --git a/gitea_client/_implementation/http_utils.py b/gitea_client/_implementation/http_utils.py
diff --git a/gitea_client/auth.py b/gitea_client/auth.py
@@ -1,7 +1,7 @@
 """
 Various classes for Gogs authentication
 """
-from gogs_client.entities import json_get
+from gitea_client.entities import json_get
 
 
 class Authentication(object):
diff --git a/gitea_client/entities.py b/gitea_client/entities.py
@@ -216,7 +216,7 @@ class Hook(GogsEntity):
         #:    Use :data:`id` instead
         hook_id = property(lambda self: self.id)
 
-        #: The hook's type (gogs, slack, etc.)
+        #: The hook's type (gitea, gogs, slack, etc.)
         #:
         #: :type: str
         type = attr.ib()
diff --git a/gitea_client/interface.py b/gitea_client/interface.py
@@ -1,8 +1,8 @@
 import requests
 
-from gogs_client._implementation.http_utils import RelativeHttpRequestor, append_url
-from gogs_client.auth import Token
-from gogs_client.entities import GogsUser, GogsRepo, GogsBranch, GogsOrg, GogsTeam
+from gitea_client._implementation.http_utils import RelativeHttpRequestor, append_url
+from gitea_client.auth import Token
+from gitea_client.entities import GogsUser, GogsRepo, GogsBranch, GogsOrg, GogsTeam
 
 
 class GogsApi(object):
@@ -397,7 +397,7 @@ def create_hook(self, auth, repo_name, hook_type, config, events=None, organizat
 
         :param auth.Authentication auth: authentication object, must be admin-level
         :param str repo_name: the name of the repo for which we create the hook
-        :param str hook_type: The type of webhook, either "gogs" or "slack"
+        :param str hook_type: The type of webhook, either "gitea", "gogs" or "slack"
         :param dict config: Settings for this hook (possible keys are
                             ``"url"``, ``"content_type"``, ``"secret"``)
         :param list events: Determines what events the hook is triggered for. Default: ["push"]
diff --git a/gitea_client/updates.py b/gitea_client/updates.py
diff --git a/gogs_client/__init__.py b/gogs_client/__init__.py
diff --git a/requirements.txt b/requirements.txt
@@ -1,3 +1,4 @@
 attrs>=17.4.0
 future
 requests
+responses
diff --git a/setup.py b/setup.py
@@ -9,13 +9,13 @@
     long_description = f.read()
 
 setup(
-    name="gogs_client",
+    name="gitea_client",
     version="1.0.7",
-    description="A python library for interacting with a gogs server",
+    description="A python library for interacting with a Gitea server",
     long_description=long_description,
-    url="https://github.com/unfoldingWord-dev/python-gogs-client",
+    url="https://github.com/unfoldingWord-dev/python-gitea-client",
     author="unfoldingWord",
-    author_email="ethantkoenig@gmail.com",
+    author_email="dev@unfoldingword.org",
     license="MIT",
     classifiers=[
         "License :: OSI Approved :: MIT License",
@@ -25,7 +25,7 @@
         'Programming Language :: Python :: 3.4',
         'Programming Language :: Python :: 3.5'
     ],
-    keywords=["gogs", "http", "client"],
+    keywords=["gitea", "gogs", "http", "client"],
     packages=find_packages(),
     install_requires=["future", "requests", "attrs"],
     test_suite="tests"
diff --git a/tests/gogs_client b/tests/gogs_client
@@ -1 +1 @@
-../gogs_client/
+../gitea_client
diff --git a/tests/http_utils_test.py b/tests/http_utils_test.py
@@ -1,6 +1,6 @@
 import unittest
 
-import gogs_client._implementation.http_utils as http_utils
+import gitea_client._implementation.http_utils as http_utils
 
 
 class HttpUtilsTest(unittest.TestCase):
diff --git a/tests/interface_test.py b/tests/interface_test.py
@@ -5,15 +5,15 @@
 import responses
 from future.moves.urllib.parse import parse_qs
 
-import gogs_client
-import gogs_client._implementation.http_utils as http_utils
+import gitea_client
+import gitea_client._implementation.http_utils as http_utils
 
 
 class GogsClientInterfaceTest(unittest.TestCase):
     def setUp(self):
         self.api_endpoint = "https://www.example.com/api/v1/"
         self.base_url = "https://www.example.com/"
-        self.client = gogs_client.GogsApi(self.base_url)
+        self.client = gitea_client.GogsApi(self.base_url)
         self.repo_json_str = """{
                 "id": 27,
                 "owner": {
@@ -178,7 +178,7 @@ def setUp(self):
                   "name": "new token",
                   "sha1": "mytoken"
                 }"""
-        self.username_password = gogs_client.UsernamePassword(
+        self.username_password = gitea_client.UsernamePassword(
             "auth_username", "password")
         self.hook_json_str = """{
                 "id": 4,
@@ -266,14 +266,14 @@ def setUp(self):
               "created_at": "2015-11-18T15:05:43-05:00",
               "read_only": true
             }]"""
-        self.expected_repo = gogs_client.GogsRepo.from_json(json.loads(self.repo_json_str))
-        self.expected_branch = gogs_client.GogsBranch.from_json(json.loads(self.branch_json_str))
-        self.expected_user = gogs_client.GogsUser.from_json(json.loads(self.user_json_str))
-        self.expected_hook = gogs_client.GogsRepo.Hook.from_json(json.loads(self.hook_json_str))
-        self.expected_org = gogs_client.GogsOrg.from_json(json.loads(self.org_json_str))
-        self.expected_team = gogs_client.GogsTeam.from_json(json.loads(self.team_json_str))
-        self.expected_key = gogs_client.GogsRepo.DeployKey.from_json(json.loads(self.deploy_key_json_str))
-        self.token = gogs_client.Token.from_json(json.loads(self.token_json_str))
+        self.expected_repo = gitea_client.GogsRepo.from_json(json.loads(self.repo_json_str))
+        self.expected_branch = gitea_client.GogsBranch.from_json(json.loads(self.branch_json_str))
+        self.expected_user = gitea_client.GogsUser.from_json(json.loads(self.user_json_str))
+        self.expected_hook = gitea_client.GogsRepo.Hook.from_json(json.loads(self.hook_json_str))
+        self.expected_org = gitea_client.GogsOrg.from_json(json.loads(self.org_json_str))
+        self.expected_team = gitea_client.GogsTeam.from_json(json.loads(self.team_json_str))
+        self.expected_key = gitea_client.GogsRepo.DeployKey.from_json(json.loads(self.deploy_key_json_str))
+        self.token = gitea_client.Token.from_json(json.loads(self.token_json_str))
 
     @responses.activate
     def test_create_repo1(self):
@@ -307,7 +307,7 @@ def test_get_repo1(self):
         responses.add(responses.GET, uri2, status=404)
         repo = self.client.get_repo(self.token, "username", "repo1")
         self.assert_repos_equal(repo, self.expected_repo)
-        self.assertRaises(gogs_client.ApiFailure, self.client.get_repo,
+        self.assertRaises(gitea_client.ApiFailure, self.client.get_repo,
                           self.token, "username", "repo2")
         self.assertEqual(len(responses.calls), 2)
         first_call = responses.calls[0]
@@ -330,7 +330,7 @@ def test_delete_repo1(self):
         responses.add(responses.DELETE, uri1, status=204)
         responses.add(responses.DELETE, uri2, status=401)
         self.client.delete_repo(self.token, "username", "repo1")
-        self.assertRaises(gogs_client.ApiFailure, self.client.delete_repo,
+        self.assertRaises(gitea_client.ApiFailure, self.client.delete_repo,
                           self.token, "otherusername", "repo2")
         self.assertEqual(len(responses.calls), 2)
         first_call = responses.calls[0]
@@ -409,7 +409,7 @@ def test_get_user1(self):
         try:
             self.client.get_user(None, "username2")
             raise AssertionError("Call to get_user did not raise an exception")
-        except gogs_client.ApiFailure as exc:
+        except gitea_client.ApiFailure as exc:
             self.assertIsNotNone(exc.message)
             self.assertEqual(exc.status_code, 404)
         self.assertEqual(len(responses.calls), 2)
@@ -420,7 +420,7 @@ def test_get_user1(self):
 
     @responses.activate
     def test_update_user1(self):
-        update = gogs_client.GogsUserUpdate.Builder("loginname", "user@example.com") \
+        update = gitea_client.GogsUserUpdate.Builder("loginname", "user@example.com") \
             .set_full_name("Example User") \
             .set_password("Password") \
             .set_website("mywebsite.net") \
@@ -456,7 +456,7 @@ def test_delete_user1(self):
         responses.add(responses.DELETE, uri1, status=204)
         responses.add(responses.DELETE, uri2, status=401)
         self.client.delete_user(self.username_password, "username1")
-        self.assertRaises(gogs_client.ApiFailure, self.client.delete_user,
+        self.assertRaises(gitea_client.ApiFailure, self.client.delete_user,
                           self.username_password, "username2")
         self.assertEqual(len(responses.calls), 2)
         first_call = responses.calls[0]
@@ -469,8 +469,8 @@ def test_delete_user1(self):
     @responses.activate
     def test_valid_authentication1(self):
         uri = self.path("/user")
-        valid_token = gogs_client.Token("a_valid_token")
-        invalid_token = gogs_client.Token("an_invalid_token")
+        valid_token = gitea_client.Token("a_valid_token")
+        invalid_token = gitea_client.Token("an_invalid_token")
 
         def callback(request):
             if request.url == self.path_with_token(uri, valid_token):
@@ -537,7 +537,7 @@ def test_create_hook1(self):
 
     @responses.activate
     def test_update_hook1(self):
-        update = gogs_client.GogsHookUpdate.Builder() \
+        update = gitea_client.GogsHookUpdate.Builder() \
             .set_events(["issues_comments"]) \
             .set_config({"url": "http://newurl.com/hook"}) \
             .set_active(True) \
