Merge pull request #94 from reddit/py_typed

Add `py.typed` + misc.

Author: mrlevitas

.gitignore

@@ -5,3 +5,4 @@ dist/
 __pycache__/
 reddit_experiments.egg-info/
 venv*
+.idea/

docs/index.rst

@@ -14,10 +14,7 @@ Prerequisite packages
 
     reddit-edgecontext>=1.0.0
 
-    # upgrade or integrate latest reddit-v2-events package
-    # or manually update thrift schemas
-    # to allow event fields to be populated in exposures
-    reddit-v2-events
+    reddit-v2-events>=2.6.0
 
 Prerequisite infrastructure
 ---------------------------
@@ -68,18 +65,17 @@ Upgrade or integrate reddit-experiments package:
 .. code-block:: python
 
     # import latest reddit-experiments package in service requirements.txt
-    reddit-experiments>=1.3.11
+    reddit-experiments>=1.3.14
 
 Initialize :code:`decider` instance on Baseplate context
 --------------------------------------------------------
 
 In your service's initialization process, add a :code:`decider` instance to baseplate's context:
-(Note the use of the :code:`ExperimentLogger`, which is used to publish exposure V2 events,
-an example can be seen `here <https://github.snooguts.net/reddit/reddit-service-graphql/blob/master/graphql-py/graphql_api/events/utils.py>`_)
 
 .. code-block:: python
 
     # application code
+    from event_utils.v2_event_utils import ExperimentLogger
     from reddit_decider import decider_client_from_config
     from reddit_decider import DeciderClient
 
@@ -100,7 +96,7 @@ an example can be seen `here <https://github.snooguts.net/reddit/reddit-service-
         baseplate.configure_context({
             "decider": DeciderClient(
                 prefix="experiments.",
-                event_logger=ExperimentLogger,
+                event_logger=ExperimentLogger()),
                 request_field_extractor=my_field_extractor  # optional
         })
 

reddit_decider/py.typed

@@ -0,0 +1 @@
+# https://www.python.org/dev/peps/pep-0561/#packaging-type-information

reddit_experiments/__init__.py

@@ -361,7 +361,7 @@ def experiments_client_from_config(
             experiment configuration fetcher daemon.
         ``timeout`` (optional)
             The time that we should wait for the file specified by ``path`` to
-            exist.  Defaults to `None` which is `infinite`.
+            exist.  (defaults to not blocking).
         ``backoff`` (optional)
             The base amount of time for exponential backoff when trying to find the
             experiments config file. Defaults to no backoff between tries.

setup.py

@@ -22,7 +22,7 @@
         "reddit-decider~=1.2.31",
         "typing_extensions>=3.10.0.0,<5.0",
     ],
-    package_data={"reddit_experiments": ["py.typed"]},
+    package_data={"reddit_experiments": ["py.typed"], "reddit_decider": ["py.typed"]},
     zip_safe=True,
     classifiers=[
         "Development Status :: 5 - Production/Stable",