Add simple_service to examples/

Author: scottzach1

README.md

@@ -118,6 +118,10 @@ if __name__ == "__main__":
     assert "hello world" == my_function()
 ```
 
+## Examples
+
+If you would like to see more examples, feel free to check out [examples/](examples).
+
 ## Authors
 
 | [![Zac Scott](https://avatars.githubusercontent.com/u/38968222?s=128&v=4)](https://github.com/scottzach1) |

examples/README.md

@@ -0,0 +1,7 @@
+# Examples
+
+This directory shows various examples of how to use the Python Injector Framework in your application.
+
+| Name                              | Description                                                                          |
+|:----------------------------------|:-------------------------------------------------------------------------------------|
+| [simple_service/](simple_service) | A bare bones application showcasing injecting an API service and mocking for pytest. |

examples/simple_service/main.py

@@ -0,0 +1,33 @@
+from pif import providers, wiring
+
+
+class ApiClient:
+    """
+    An API client that takes a domain and token.
+    """
+
+    def __init__(self, domain: str, token: str):
+        assert domain and token
+
+    def do_stuff(self): ...
+
+
+# Define some providers to use for injection.
+ApiDomainProvider = providers.BlankProvider()
+ApiTokenProvider = providers.BlankProvider()
+ApiClientProvider = providers.Singleton[ApiClient](ApiClient, domain=ApiDomainProvider, token=ApiTokenProvider)
+
+
+@wiring.injected
+def main(client: ApiClient = ApiClientProvider):
+    """
+    Your application logic.
+    """
+    client.do_stuff()
+
+
+if __name__ == "__main__":
+    ApiDomainProvider.override_existing("example.domain.com")
+    ApiTokenProvider.override_existing("*****")
+
+    main()

examples/simple_service/test.py

@@ -0,0 +1,15 @@
+from unittest.mock import MagicMock
+
+import main
+
+
+def test_main():
+    """
+    Showcase how we can patch our main method for testing.
+    """
+    mock = MagicMock()
+
+    with main.ApiClientProvider.override_existing(mock):
+        main.main()
+
+    assert mock.do_stuff.call_count == 1