getcohorts 1.0.0

Utilities for randomizing A/B tests

GetCohorts

GetCohorts provides an endpoint that will randomly determine a cohort for a user in an A/B test, and is gauranteed to always assign the same user to the same cohort for the same experiment.

>>> import requests
>>> resp = requests.get('http://api.getcohorts.com/v1/cohorts', json={
...    'identifier': 'user1',
...    'experiment': 'homepage-test'
... })
>>> print(resp.json()['cohort'])
experimental

More details on using the service are available on the documentation site.

• Documentation
• API Reference

Quickstart

GetCohorts provides a web service at http://api.getcohorts.com that you can use for testing. But that service runs on Heroku's free tier, and can occasionally have slow response times. So we recommend that you deploy GetCohorts yourself.

Deploy with Docker

docker run --publish 8000:8000 tjwaterman99/getcohorts

Deploy to Heroku

You can also deploy to Heroku directly with the button below.

Deploy from PyPI

You can also download the Python package from PyPI and deploy yourself. For instructions, see the docs section on deploying with pypi.

Development

Clone this repo.

git clone https://github.com/tjwaterman99/getcohorts.git

Install the package's dependencies. This will also install getcohorts in editable mode.

pip install -r requirements.txt

Run the uvicorn server locally in development mode.

uvicorn getcohorts.web:app --host 0.0.0.0 --port 8000 --reload

Testing

Run the tests with pytest. Note that the tests assume the webserver is running locally on port 8000, and they will fail if you have not started the webserver.

pytest

You can run the github CI workflows locally if you have act installed.

act

Documentation

Build the docs with mkdocs. The site is available at 0.0.0.0:8000.

mkdocs serve