Merge pull request #74 from Kinto/rename-kinto-http.py

Natim · web-flow · commit a307057c617a · 2016-06-10T10:47:48.000+02:00
Rename kinto-client to kinto-http.
diff --git a/.coveragerc b/.coveragerc
@@ -1,2 +1,2 @@
 [run]
-omit = kinto_client/tests/*
+omit = kinto_http/tests/*
diff --git a/.gitignore b/.gitignore
@@ -1,6 +1,6 @@
 .cache
 *.pyc
-kinto_client.egg-info/
+kinto_http.egg-info/
 .coverage
 .venv/
 .tox
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -4,10 +4,12 @@ CHANGELOG
 This document describes changes between each past release.
 
 
-5.1.0 (unreleased)
+6.0.0 (unreleased)
 ==================
 
-- Nothing changed yet.
+**Breaking changes**
+
+- Rename kinto_client to kinto_http (#74)
 
 
 5.0.0 (2016-05-12)
@@ -87,7 +89,7 @@ This document describes changes between each past release.
 - Added a retry option for batch requests (#51)
 - Use the "default" bucket if nothing is specified (#50)
 - Added a ``if_not_exists`` argument to the creation methods (#42)
-- Added a replication mechanism in ``kinto_client.replication`` (#26)
+- Added a replication mechanism in ``kinto_http.replication`` (#26)
 - Handle the ``last_modified`` argument on update or create operations (#24)
 
 **Bug fixes**
diff --git a/MANIFEST.in b/MANIFEST.in
@@ -1,4 +1,4 @@
 include *.rst README.rst CHANGELOG.rst tox.ini Makefile .coveragerc
 include *.txt
 include LICENSE
-recursive-include kinto_client *.ini
+recursive-include kinto_http *.ini
diff --git a/Makefile b/Makefile
@@ -30,17 +30,17 @@ need-kinto-running:
 	@curl http://localhost:8888/v0/ 2>/dev/null 1>&2 || (echo "Run 'make runkinto' before starting tests." && exit 1)
 
 runkinto: install-dev
-	$(VENV)/bin/kinto --ini kinto_client/tests/config/kinto.ini migrate
-	$(VENV)/bin/kinto --ini kinto_client/tests/config/kinto.ini start
+	$(VENV)/bin/kinto --ini kinto_http/tests/config/kinto.ini migrate
+	$(VENV)/bin/kinto --ini kinto_http/tests/config/kinto.ini start
 
 tests-once: install-dev
-	$(VENV)/bin/py.test --cov-report term-missing --cov-fail-under 100 --cov kinto_client
+	$(VENV)/bin/py.test --cov-report term-missing --cov-fail-under 100 --cov kinto_http
 
 functional: install-dev need-kinto-running
-	$(VENV)/bin/py.test kinto_client/tests/functional.py
+	$(VENV)/bin/py.test kinto_http/tests/functional.py
 
 tests: install-dev need-kinto-running
-	$(VENV)/bin/py.test -f kinto_client/tests/ kinto_client/tests/functional.py
+	$(VENV)/bin/py.test -f kinto_http/tests/ kinto_http/tests/functional.py
 
 clean:
 	find . -name '*.pyc' -delete
diff --git a/README.rst b/README.rst
@@ -1,20 +1,20 @@
 Kinto python client
 ###################
 
-.. image:: https://img.shields.io/travis/Kinto/kinto.py.svg
-        :target: https://travis-ci.org/Kinto/kinto.py
+.. image:: https://img.shields.io/travis/Kinto/kinto-http.py.svg
+        :target: https://travis-ci.org/Kinto/kinto-http.py
 
-.. image:: https://img.shields.io/pypi/v/kinto-client.svg
-        :target: https://pypi.python.org/pypi/kinto-client
+.. image:: https://img.shields.io/pypi/v/kinto-http.svg
+        :target: https://pypi.python.org/pypi/kinto-http
 
-.. image:: https://coveralls.io/repos/Kinto/kinto.py/badge.svg?branch=master
-        :target: https://coveralls.io/r/Kinto/kinto.py
+.. image:: https://coveralls.io/repos/Kinto/kinto-http.py/badge.svg?branch=master
+        :target: https://coveralls.io/r/Kinto/kinto-http.py
 
 
 Kinto is a service that allows to store and synchronize arbitrary data,
 attached to a user account. Its primary interface is HTTP.
 
-*kinto-client* is a Python library that eases the interactions with
+*kinto-http* is a Python library that eases the interactions with
 a *Kinto* server instance. `A project with related goals is
 also available for JavaScript <https://github.com/kinto/kinto.js>`_.
 
@@ -24,7 +24,7 @@ Installation
 
 Use pip::
 
-  $ pip install kinto-client
+  $ pip install kinto-http
 
 
 Usage
@@ -43,7 +43,7 @@ Here is an overview of what the API provides:
 
 .. code-block:: python
 
-    from kinto_client import Client
+    from kinto_http import Client
 
     client = Client(server_url="http://localhost:8888/v1",
                     auth=('alexis', 'p4ssw0rd'))
@@ -68,7 +68,7 @@ Basic authentication policies.
 
 .. code-block:: python
 
-    from kinto_client import Client
+    from kinto_http import Client
     credentials = ('alexis', 'p4ssw0rd')
 
     client = Client(server_url='http://localhost:8888/v1',
@@ -89,7 +89,7 @@ You can use the ``server_info`` method to get the server information::
 
 .. code-block:: python
 
-    from kinto_client import Client
+    from kinto_http import Client
 
     client = Client(server_url='http://localhost:8888/v1')
     info = client.server_info()
@@ -105,7 +105,7 @@ If no specific bucket name is provided, the "default" bucket is used.
 
 .. code-block:: python
 
-    from kinto_client import Client
+    from kinto_http import Client
     credentials = ('alexis', 'p4ssw0rd')
 
     client = Client(server_url='http://localhost:8888/v1',
@@ -257,7 +257,7 @@ To enable this, specify the number of retries on the client:
                   retry=10)
 
 The Kinto protocol lets the server `define the duration in seconds between retries
-<https://kinto.readthedocs.io/en/latest/api/1.x/cliquet/backoff.html#retry-after-indicators>`_.
+<https://kinto.readthedocs.io/en/latest/api/1.x/backoff.html>`_.
 It is possible (but not recommended) to force this value in the clients:
 
 .. code-block:: python
@@ -297,7 +297,7 @@ to ease configuration and initialization of client from command-line arguments.
   import argparse
   import logging
 
-  from kinto_client import cli_utils
+  from kinto_http import cli_utils
 
   logger = logging.getLogger(__name__)
 
diff --git a/kinto_http/__init__.py b/kinto_http/__init__.py
@@ -5,10 +5,10 @@
 from contextlib import contextmanager
 
 
-from kinto_client import utils
-from kinto_client.session import create_session, Session
-from kinto_client.batch import BatchSession
-from kinto_client.exceptions import BucketNotFound, KintoException
+from kinto_http import utils
+from kinto_http.session import create_session, Session
+from kinto_http.batch import BatchSession
+from kinto_http.exceptions import BucketNotFound, KintoException
 
 
 __all__ = ('Endpoints', 'Session', 'Client',
diff --git a/kinto_http/batch.py b/kinto_http/batch.py
@@ -1,7 +1,7 @@
 from . import utils
 from collections import defaultdict
 
-from kinto_client.exceptions import KintoException
+from kinto_http.exceptions import KintoException
 
 
 class BatchSession(object):
diff --git a/kinto_http/cli_utils.py b/kinto_http/cli_utils.py
diff --git a/kinto_http/exceptions.py b/kinto_http/exceptions.py
diff --git a/kinto_http/replication.py b/kinto_http/replication.py
@@ -1,7 +1,7 @@
 import argparse
 import logging
 
-from kinto_client import Client, cli_utils
+from kinto_http import Client, cli_utils
 
 logger = logging.getLogger(__name__)
 
diff --git a/kinto_http/session.py b/kinto_http/session.py
@@ -3,8 +3,8 @@
 import requests
 from six.moves.urllib.parse import urlparse
 
-from kinto_client import utils
-from kinto_client.exceptions import KintoException
+from kinto_http import utils
+from kinto_http.exceptions import KintoException
 
 
 def create_session(server_url=None, auth=None, session=None, retry=0,
diff --git a/kinto_http/tests/__init__.py b/kinto_http/tests/__init__.py
diff --git a/kinto_http/tests/config/kinto.ini b/kinto_http/tests/config/kinto.ini
diff --git a/kinto_http/tests/functional.py b/kinto_http/tests/functional.py
@@ -5,10 +5,10 @@
 import requests
 from six.moves import configparser
 
-from cliquet import utils as cliquet_utils
+from kinto.core import utils as kinto_core_utils
 
-from kinto_client import Client, BucketNotFound, KintoException
-from kinto_client import replication
+from kinto_http import Client, BucketNotFound, KintoException
+from kinto_http import replication
 
 __HERE__ = os.path.abspath(os.path.dirname(__file__))
 
@@ -38,7 +38,7 @@ def tearDown(self):
     def get_user_id(self, credentials):
         hmac_secret = self.config.get('app:main', 'kinto.userid_hmac_secret')
         credentials = '%s:%s' % credentials
-        digest = cliquet_utils.hmac_digest(hmac_secret, credentials)
+        digest = kinto_core_utils.hmac_digest(hmac_secret, credentials)
         return 'basicauth:%s' % digest
 
     def test_bucket_creation(self):
diff --git a/kinto_http/tests/support.py b/kinto_http/tests/support.py
@@ -2,7 +2,7 @@
 
 import mock
 
-from kinto_client.exceptions import KintoException
+from kinto_http.exceptions import KintoException
 
 
 def mock_response(session, data=None, permissions=None, headers=None,
diff --git a/kinto_http/tests/test_batch.py b/kinto_http/tests/test_batch.py
@@ -1,8 +1,8 @@
 import unittest2 as unittest
 import mock
 
-from kinto_client.batch import BatchSession
-from kinto_client.exceptions import KintoException
+from kinto_http.batch import BatchSession
+from kinto_http.exceptions import KintoException
 
 
 class BatchRequestsTest(unittest.TestCase):
diff --git a/kinto_http/tests/test_cli_utils.py b/kinto_http/tests/test_cli_utils.py
@@ -1,7 +1,7 @@
 import argparse
 import mock
 
-from kinto_client import cli_utils
+from kinto_http import cli_utils
 from .support import unittest
 
 ALL_PARAMETERS = [
@@ -95,7 +95,7 @@ def test_get_auth_is_called_by_argparse(self):
 
 class ClientFromArgsTest(unittest.TestCase):
 
-    @mock.patch('kinto_client.cli_utils.Client')
+    @mock.patch('kinto_http.cli_utils.Client')
     def test_create_client_from_args_build_a_client(self, mocked_client):
         parser = cli_utils.add_parser_options(
             default_server="https://firefox.settings.services.mozilla.com/",
@@ -113,7 +113,7 @@ def test_create_client_from_args_build_a_client(self, mocked_client):
             bucket='blocklists',
             collection='certificates')
 
-    @mock.patch('kinto_client.cli_utils.Client')
+    @mock.patch('kinto_http.cli_utils.Client')
     def test_create_client_from_args_default_bucket_and_collection_to_none(
             self, mocked_client):
         parser = cli_utils.add_parser_options(
diff --git a/kinto_http/tests/test_client.py b/kinto_http/tests/test_client.py
@@ -2,8 +2,8 @@
 from six import text_type
 from .support import unittest, mock_response, build_response, get_http_error
 
-from kinto_client import (KintoException, BucketNotFound, Client,
-                          DO_NOT_OVERWRITE)
+from kinto_http import (KintoException, BucketNotFound, Client,
+                        DO_NOT_OVERWRITE)
 
 
 class ClientTest(unittest.TestCase):
@@ -72,7 +72,7 @@ def test_batch_raises_exception_if_subrequest_failed(self):
     def test_batch_options_are_transmitted(self):
         settings = {"batch_max_requests": 25}
         self.session.request.side_effect = [({"settings": settings}, [])]
-        with mock.patch('kinto_client.create_session') as create_session:
+        with mock.patch('kinto_http.create_session') as create_session:
             with self.client.batch(bucket='moz', collection='test', retry=12,
                                    retry_after=20):
                 _, last_call_kwargs = create_session.call_args_list[-1]
diff --git a/kinto_http/tests/test_endpoints.py b/kinto_http/tests/test_endpoints.py
@@ -1,7 +1,7 @@
 from six import text_type
 from .support import unittest
 
-from kinto_client import Endpoints, KintoException
+from kinto_http import Endpoints, KintoException
 
 
 class EndpointsTest(unittest.TestCase):
diff --git a/kinto_http/tests/test_replication.py b/kinto_http/tests/test_replication.py
@@ -1,8 +1,8 @@
 import mock
 
-from kinto_client.replication import replicate
-from kinto_client import Client
-from kinto_client import exceptions
+from kinto_http.replication import replicate
+from kinto_http import Client
+from kinto_http import exceptions
 
 from .support import unittest, mock_response
 
@@ -63,7 +63,7 @@ def test_removed_records_are_deleted_on_the_destination(self):
         batched.delete_record.assert_any_call('1234', last_modified='1234')
         batched.delete_record.assert_any_call('4567', last_modified='4567')
 
-    @mock.patch('kinto_client.replication.logger')
+    @mock.patch('kinto_http.replication.logger')
     def test_logger_outputs_replication_information(self, logger):
         origin_session = mock.MagicMock()
         origin_session.server_url = "http://origin/v1"
diff --git a/kinto_http/tests/test_session.py b/kinto_http/tests/test_session.py
@@ -1,14 +1,14 @@
 import mock
 
-from kinto_client.session import Session, create_session
-from kinto_client.exceptions import KintoException
+from kinto_http.session import Session, create_session
+from kinto_http.exceptions import KintoException
 
 from .support import unittest, get_200, get_503, get_403
 
 
 class SessionTest(unittest.TestCase):
     def setUp(self):
-        p = mock.patch('kinto_client.session.requests')
+        p = mock.patch('kinto_http.session.requests')
         self.requests_mock = p.start()
         self.addCleanup(p.stop)
 
@@ -115,7 +115,7 @@ def test_creation_fails_if_session_and_server_url(self):
     def test_initialization_fails_on_missing_args(self):
         self.assertRaises(AttributeError, create_session)
 
-    @mock.patch('kinto_client.session.Session')
+    @mock.patch('kinto_http.session.Session')
     def test_creates_a_session_if_needed(self, session_mock):
         # Mock the session response.
         create_session(server_url=mock.sentinel.server_url,
@@ -161,7 +161,7 @@ def test_payload_is_sent_on_put_requests(self):
 class RetryRequestTest(unittest.TestCase):
 
     def setUp(self):
-        p = mock.patch('kinto_client.session.requests')
+        p = mock.patch('kinto_http.session.requests')
         self.requests_mock = p.start()
         self.addCleanup(p.stop)
 
@@ -207,7 +207,7 @@ def test_does_not_retry_on_400_errors(self):
     def test_does_not_wait_if_retry_after_header_is_not_present(self):
         self.requests_mock.request.side_effect = [self.response_503,
                                                   self.response_200]
-        with mock.patch('kinto_client.session.time.sleep') as sleep_mocked:
+        with mock.patch('kinto_http.session.time.sleep') as sleep_mocked:
             session = Session('https://example.org', retry=1)
             session.request('GET', '/v1/foobar')
             sleep_mocked.assert_called_with(0)
@@ -216,15 +216,15 @@ def test_waits_if_retry_after_header_is_present(self):
         self.response_503.headers["Retry-After"] = 27
         self.requests_mock.request.side_effect = [self.response_503,
                                                   self.response_200]
-        with mock.patch('kinto_client.session.time.sleep') as sleep_mocked:
+        with mock.patch('kinto_http.session.time.sleep') as sleep_mocked:
             session = Session('https://example.org', retry=1)
             session.request('GET', '/v1/foobar')
             self.assertTrue(sleep_mocked.called)
 
     def test_waits_if_retry_after_is_forced(self):
         self.requests_mock.request.side_effect = [self.response_503,
                                                   self.response_200]
-        with mock.patch('kinto_client.session.time.sleep') as sleep_mocked:
+        with mock.patch('kinto_http.session.time.sleep') as sleep_mocked:
             session = Session('https://example.org', retry=1, retry_after=10)
             session.request('GET', '/v1/foobar')
             sleep_mocked.assert_called_with(10)
@@ -233,7 +233,7 @@ def test_forced_retry_after_overrides_value_of_header(self):
         self.response_503.headers["Retry-After"] = 27
         self.requests_mock.request.side_effect = [self.response_503,
                                                   self.response_200]
-        with mock.patch('kinto_client.session.time.sleep') as sleep_mocked:
+        with mock.patch('kinto_http.session.time.sleep') as sleep_mocked:
             session = Session('https://example.org', retry=1, retry_after=10)
             session.request('GET', '/v1/foobar')
             sleep_mocked.assert_called_with(10)
diff --git a/kinto_http/tests/test_utils.py b/kinto_http/tests/test_utils.py
diff --git a/kinto_http/utils.py b/kinto_http/utils.py
diff --git a/setup.py b/setup.py
diff --git a/tox.ini b/tox.ini

Original file line number	Diff line number	Diff line change
`@@ -1,2 +1,2 @@`
`1`	`1`	`[run]`
`2`		`-omit = kinto_client/tests/*`
	`2`	`+omit = kinto_http/tests/*`