Make into a stand-alone library

Author: spladug

.drone.yml

@@ -0,0 +1,32 @@
+---
+kind: pipeline
+name: Lint & Test
+
+steps:
+  - name: "Lint"
+    image: python:3.8
+    commands:
+      - pip install -r requirements.txt
+      - make lint
+    depends_on: [clone]
+
+  - name: "Test - Py3.6"
+    image: python:3.6
+    commands:
+      - pip install -r requirements.txt
+      - make test
+    depends_on: [clone]
+
+  - name: "Test - Py3.7"
+    image: python:3.7
+    commands:
+      - pip install -r requirements.txt
+      - make test
+    depends_on: [clone]
+
+  - name: "Test - Py3.8"
+    image: python:3.8
+    commands:
+      - pip install -r requirements.txt
+      - make test
+    depends_on: [clone]

.gitignore

@@ -0,0 +1,6 @@
+build/
+.coverage
+dist/
+.eggs/
+__pycache__/
+reddit_experiments.egg-info/

LICENSE

@@ -0,0 +1,27 @@
+Copyright (c) 2021 Reddit Inc.
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions
+are met:
+
+1. Redistributions of source code must retain the above copyright
+   notice, this list of conditions and the following disclaimer.
+2. Redistributions in binary form must reproduce the above copyright
+   notice, this list of conditions and the following disclaimer in the
+   documentation and/or other materials provided with the distribution.
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+SUCH DAMAGE.

Makefile

@@ -0,0 +1,26 @@
+SOURCE_ROOT := reddit_experiments/
+PYTHON_SOURCE = $(shell find $(SOURCE_ROOT) tests/ setup.py -name '*.py')
+REORDER_PYTHON_IMPORTS := reorder-python-imports --py3-plus --separate-from-import --separate-relative
+
+
+.PHONY: fmt
+fmt:
+	$(REORDER_PYTHON_IMPORTS) --exit-zero-even-if-changed $(PYTHON_SOURCE)
+	black $(PYTHON_SOURCE)
+
+
+.PHONY: lint
+lint:
+	$(REORDER_PYTHON_IMPORTS) --diff-only $(PYTHON_SOURCE)
+	black --diff --check $(PYTHON_SOURCE)
+	flake8 $(SOURCE_ROOT)
+	mypy $(SOURCE_ROOT)
+
+.PHONY: test
+test:
+	python -m pytest -v tests/
+
+
+.PHONY: docs
+docs:
+	sphinx-build -M html docs/ build/

README.md

@@ -0,0 +1,4 @@
+# experiments.py
+
+This is a work-in-progress extraction of the Python experiments framework from
+Baseplate.py.

docs/conf.py

@@ -0,0 +1,110 @@
+# sphinx docs config
+#
+# This file is execfile()d with the current directory set to its
+# containing dir.
+import os
+import sys
+
+import alabaster
+
+# where to find the modules to import for autodoc
+sys.path.insert(0, os.path.abspath(".."))
+
+# -- General configuration ------------------------------------------------
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = [
+    "alabaster",
+    "sphinx.ext.autodoc",
+    "sphinx.ext.doctest",
+    "sphinx.ext.intersphinx",
+    "sphinx.ext.viewcode",
+    "sphinx_autodoc_typehints",
+]
+
+intersphinx_mapping = {
+    "python": ("https://docs.python.org/3.7", None),
+    "baseplate": ("https://baseplate.readthedocs.io/en/stable/", None),
+}
+
+# The suffix of source filenames.
+source_suffix = ".rst"
+
+# The encoding of source files.
+source_encoding = "utf-8"
+
+# The master toctree document.
+master_doc = "index"
+
+# General information about the project.
+project = "reddit_experiments"
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+language = "en"
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+exclude_patterns = ["docs/html"]
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = "friendly"
+
+# -- Options for HTML output ----------------------------------------------
+
+html_theme_path = [alabaster.get_path()]
+html_static_path = []
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+html_theme = "alabaster"
+
+# The name for this set of Sphinx documents.  If None, it defaults to
+# "<project> v<release> documentation".
+# html_title =
+
+# which templates to put in the sidebar.  we're just removing the relations
+# section from the defaults here, that's "next article" and "previous article"
+html_sidebars = {
+    "**": ["about.html", "searchbox.html", "navigation.html"]
+}
+
+html_theme_options = {
+    "description": "Reddit's Python Experiments Framework",
+    "github_button": False,
+    "github_repo": "experiments.py",
+    "github_user": "reddit",
+    "github_banner": True,
+    "logo_name": True,
+    "show_powered_by": False,
+    "show_related": False,
+    "show_relbars": True,
+    "page_width": "960px",
+}
+
+# The name of an image file (within the static path) to use as favicon of the
+# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
+# pixels large.
+html_favicon = "images/favicon.png"
+
+# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
+# using the given strftime format.
+html_last_updated_fmt = "%b %d, %Y"
+
+# If true, SmartyPants will be used to convert quotes and dashes to
+# typographically correct entities.
+html_use_smartypants = True
+
+# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
+html_show_sphinx = False
+
+# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
+html_show_copyright = False
+
+# -- Autodoc --
+autodoc_member_order = "bysource"
+
+# -- Spelling --
+spelling_word_list_filename = "words.txt"
+spelling_show_suggestions = True

docs/index.rst

@@ -1,7 +1,7 @@
-``baseplate.lib.experiments``
+``reddit_experiments``
 ===============================
 
-.. automodule:: baseplate.lib.experiments
+.. automodule:: reddit_experiments
 
 Configuration Parsing
 ---------------------

pyproject.toml

@@ -0,0 +1,3 @@
+[tool.black]
+line-length = 100
+target-version = ['py36']

reddit_experiments/__init__.py

@@ -15,11 +15,12 @@
 from baseplate.lib.edge_context import User
 from baseplate.lib.events import DebugLogger
 from baseplate.lib.events import EventLogger
-from baseplate.lib.experiments.providers import parse_experiment
-from baseplate.lib.experiments.providers.base import Experiment
 from baseplate.lib.file_watcher import FileWatcher
 from baseplate.lib.file_watcher import WatchedFileNotAvailableError
 
+from reddit_experiments.providers import parse_experiment
+from reddit_experiments.providers.base import Experiment
+
 
 logger = logging.getLogger(__name__)
 
@@ -33,7 +34,7 @@ class ExperimentsContextFactory(ContextFactory):
     """Experiment client context factory.
 
     This factory will attach a new
-    :py:class:`baseplate.lib.experiments.Experiments` to an attribute on the
+    :py:class:`reddit_experiments.Experiments` to an attribute on the
     :py:class:`~baseplate.RequestContext`.
 
     :param path: Path to the experiment configuration file.

reddit_experiments/providers/__init__.py

@@ -5,11 +5,12 @@
 from typing import Dict
 
 from baseplate.lib import warn_deprecated
-from baseplate.lib.experiments.providers.base import Experiment
-from baseplate.lib.experiments.providers.feature_flag import FeatureFlag
-from baseplate.lib.experiments.providers.forced_variant import ForcedVariantExperiment
-from baseplate.lib.experiments.providers.r2 import R2Experiment
-from baseplate.lib.experiments.providers.simple_experiment import SimpleExperiment
+
+from reddit_experiments.providers.base import Experiment
+from reddit_experiments.providers.feature_flag import FeatureFlag
+from reddit_experiments.providers.forced_variant import ForcedVariantExperiment
+from reddit_experiments.providers.r2 import R2Experiment
+from reddit_experiments.providers.simple_experiment import SimpleExperiment
 
 logger = logging.getLogger(__name__)
 

reddit_experiments/providers/feature_flag.py

@@ -1,7 +1,7 @@
 from typing import Any
 from typing import Dict
 
-from baseplate.lib.experiments.providers.r2 import R2Experiment
+from reddit_experiments.providers.r2 import R2Experiment
 
 
 class FeatureFlag(R2Experiment):

reddit_experiments/providers/forced_variant.py

@@ -1,7 +1,7 @@
 from typing import Any
 from typing import Optional
 
-from baseplate.lib.experiments.providers.base import Experiment
+from reddit_experiments.providers.base import Experiment
 
 
 class ForcedVariantExperiment(Experiment):

reddit_experiments/providers/r2.py

@@ -6,7 +6,7 @@
 from typing import List
 from typing import Optional
 
-from baseplate.lib.experiments.providers.base import Experiment
+from reddit_experiments.providers.base import Experiment
 
 
 logger = logging.getLogger(__name__)

reddit_experiments/providers/simple_experiment.py

@@ -8,14 +8,14 @@
 from typing import Optional
 from typing import Type
 
-from baseplate.lib.experiments.providers.base import Experiment
-from baseplate.lib.experiments.targeting.base import Targeting
-from baseplate.lib.experiments.targeting.tree_targeting import create_targeting_tree
-from baseplate.lib.experiments.variant_sets.base import VariantSet
-from baseplate.lib.experiments.variant_sets.multi_variant_set import MultiVariantSet
-from baseplate.lib.experiments.variant_sets.range_variant_set import RangeVariantSet
-from baseplate.lib.experiments.variant_sets.rollout_variant_set import RolloutVariantSet
-from baseplate.lib.experiments.variant_sets.single_variant_set import SingleVariantSet
+from reddit_experiments.providers.base import Experiment
+from reddit_experiments.targeting.base import Targeting
+from reddit_experiments.targeting.tree_targeting import create_targeting_tree
+from reddit_experiments.variant_sets.base import VariantSet
+from reddit_experiments.variant_sets.multi_variant_set import MultiVariantSet
+from reddit_experiments.variant_sets.range_variant_set import RangeVariantSet
+from reddit_experiments.variant_sets.rollout_variant_set import RolloutVariantSet
+from reddit_experiments.variant_sets.single_variant_set import SingleVariantSet
 
 
 logger = logging.getLogger(__name__)

reddit_experiments/targeting/tree_targeting.py

@@ -7,7 +7,7 @@
 from typing import List
 from typing import Type
 
-from baseplate.lib.experiments.targeting.base import Targeting
+from reddit_experiments.targeting.base import Targeting
 
 
 logger = logging.getLogger(__name__)

reddit_experiments/variant_sets/multi_variant_set.py

@@ -3,7 +3,7 @@
 from typing import List
 from typing import Optional
 
-from baseplate.lib.experiments.variant_sets.base import VariantSet
+from reddit_experiments.variant_sets.base import VariantSet
 
 
 class MultiVariantSet(VariantSet):

reddit_experiments/variant_sets/range_variant_set.py

@@ -3,7 +3,7 @@
 from typing import List
 from typing import Optional
 
-from baseplate.lib.experiments.variant_sets.base import VariantSet
+from reddit_experiments.variant_sets.base import VariantSet
 
 
 class RangeVariantSet(VariantSet):

reddit_experiments/variant_sets/rollout_variant_set.py

@@ -3,7 +3,7 @@
 from typing import List
 from typing import Optional
 
-from baseplate.lib.experiments.variant_sets.base import VariantSet
+from reddit_experiments.variant_sets.base import VariantSet
 
 
 class RolloutVariantSet(VariantSet):

reddit_experiments/variant_sets/single_variant_set.py

@@ -3,7 +3,7 @@
 from typing import List
 from typing import Optional
 
-from baseplate.lib.experiments.variant_sets.base import VariantSet
+from reddit_experiments.variant_sets.base import VariantSet
 
 
 class SingleVariantSet(VariantSet):