Readme

Author: githubjakob

README.md

@@ -1 +1,20 @@
 # Twilio Conversations Client Mock
+
+Current status: Under development as a hobby project.
+
+Works for the most basic operations, e.g. `conversations.create()` or `conversations(sid).fetch()`.
+Currently many operations, fields or error cases are not implemented. (See the [tests](https://github.com/githubjakob/pytest-twilio-conversations-client-mock/tests/README.md))
+
+## Usage
+
+```
+pip install pytest-twilio-conversations-client-mock
+```
+
+Mock the Twilio Client in your tests:
+
+```
+patch("twilio.rest.Client", return_value=ClientMock()).start()
+```
+
+More see [example](https://github.com/githubjakob/pytest-twilio-conversations-client-mock/example/README.md).

example/README.md

@@ -0,0 +1 @@
+# Example

example/app.py

@@ -8,3 +8,7 @@
 
 def create_a_twilio_conversation():
     return twilio_client.conversations.v1.conversations.create()
+
+
+def fetch_a_twilio_conversation(sid):
+    return twilio_client.conversations.v1.conversations(sid).fetch()

example/conftest.py

@@ -1,5 +1,5 @@
 from unittest.mock import patch
 
-from client import ClientMock
+from twilio_conversations_mock.client import ClientMock
 
 patch("twilio.rest.Client", return_value=ClientMock()).start()

example/requierements.txt

@@ -0,0 +1 @@
+pytest-twilio-conversations-client-mock==0.0.2

example/test.py

@@ -1,9 +1,13 @@
-from example.app import create_a_twilio_conversation
+from example.app import create_a_twilio_conversation, fetch_a_twilio_conversation
 
 
-def test_create_a_twilio_conversation():
+def test_testing_the_mock():
 
     conversation = create_a_twilio_conversation()
 
     assert conversation.sid is not None
     assert type(conversation.sid) is str
+
+    fetched_conversation = fetch_a_twilio_conversation(conversation.sid)
+
+    assert conversation.sid == fetched_conversation.sid

setup.py

@@ -1,17 +1,16 @@
 from setuptools import setup
 
-from __version__ import __version__
-
 setup(
     name="pytest-twilio-conversations-client-mock",
     description="",
     long_description="",
-    author="",
-    license="MIT license",
-    author_email="",
-    url="",
-    version=__version__,
+    author="Jakob",
+    license="GPL-3.0-or-later",
+    author_email="[email protected]",
+    url="https://github.com/githubjakob/pytest-twilio-conversations-client-mock",
+    version="0.0.2",
     classifiers=[],
+    packages=["twilio_conversations_mock"],
     install_requires=[
         "twilio==7.12.0",  # TODO mock depends on TwilioRestException
     ],