cleanup tests, add instructions to readme

Author: neilkakkar

.gitignore

@@ -13,3 +13,5 @@ flake8.out
 pylint.out
 posthog-analytics
 .idea
+.python-version
+.coverage

Makefile

@@ -1,7 +1,10 @@
-test:
+lint:
 	pylint --rcfile=.pylintrc --reports=y --exit-zero analytics | tee pylint.out
 	flake8 --max-complexity=10 --statistics analytics > flake8.out || true
-	coverage run --branch --include=analytics/\* --omit=*/test* setup.py test
+
+test:
+	coverage run -m pytest
+	coverage report
 
 release:
 	rm -rf dist/*
@@ -26,4 +29,4 @@ release_analytics:
 e2e_test:
 	.buildscripts/e2e.sh
 
-.PHONY: test release e2e_test
+.PHONY: test lint release e2e_test

README.md

@@ -7,3 +7,12 @@ Specifically, the [Python integration](https://posthog.com/docs/integrations/pyt
 ## Questions?
 
 ### [Join our Slack community.](https://join.slack.com/t/posthogusers/shared_invite/enQtOTY0MzU5NjAwMDY3LTc2MWQ0OTZlNjhkODk3ZDI3NDVjMDE1YjgxY2I4ZjI4MzJhZmVmNjJkN2NmMGJmMzc2N2U3Yjc3ZjI5NGFlZDQ)
+
+# Running & Testing Locally
+
+1. Run `python3 -m venv env` (creates virtual environment called "env")
+2. Run `source env/bin/activate` (activates the virtual environment)
+3. Run `python3 -m pip install -e ".[test]"` (installs the package in develop mode, along with test dependencies)
+4. Run `make test`
+
+To run tests specific to a file, use 

posthog/__init__.py

@@ -32,7 +32,7 @@ def capture(
 
     A `capture` call requires
     - `distinct id` which uniquely identifies your user
-    - `event name` to make sure
+    - `event name` to specify the event
     - We recommend using [verb] [noun], like `movie played` or `movie updated` to easily identify what your events mean later on.
 
     Optionally you can submit

posthog/test/client.py posthog/test/test_client.pyposthog/test/client.py renamed to posthog/test/test_client.py

@@ -1,14 +1,15 @@
 import time
 import unittest
 from datetime import date, datetime
+from uuid import uuid4
 
 import mock
 import six
 from freezegun import freeze_time
 
 from posthog.client import Client
 from posthog.request import APIError
-from posthog.test.utils import TEST_API_KEY
+from posthog.test.test_utils import TEST_API_KEY
 from posthog.version import VERSION
 
 
@@ -122,6 +123,16 @@ def test_basic_page(self):
         self.assertEqual(msg["distinct_id"], "distinct_id")
         self.assertEqual(msg["properties"]["$current_url"], "https://posthog.com/contact")
 
+    def test_basic_page_distinct_uuid(self):
+        client = self.client
+        distinct_id = uuid4()
+        success, msg = client.page(distinct_id, url="https://posthog.com/contact")
+        self.assertFalse(self.failed)
+        client.flush()
+        self.assertTrue(success)
+        self.assertEqual(msg["distinct_id"], str(distinct_id))
+        self.assertEqual(msg["properties"]["$current_url"], "https://posthog.com/contact")
+
     def test_advanced_page(self):
         client = self.client
         success, msg = client.page(

posthog/test/consumer.py posthog/test/test_consumer.pyposthog/test/consumer.py renamed to posthog/test/test_consumer.py

@@ -11,7 +11,7 @@
 
 from posthog.consumer import MAX_MSG_SIZE, Consumer
 from posthog.request import APIError
-from posthog.test.utils import TEST_API_KEY
+from posthog.test.test_utils import TEST_API_KEY
 
 
 class TestConsumer(unittest.TestCase):

posthog/test/module.py posthog/test/test_module.pyposthog/test/module.py renamed to posthog/test/test_module.py

@@ -5,7 +5,7 @@
 import requests
 
 from posthog.request import DatetimeSerializer, batch_post
-from posthog.test.utils import TEST_API_KEY
+from posthog.test.test_utils import TEST_API_KEY
 
 
 class TestRequests(unittest.TestCase):

posthog/test/request.py posthog/test/test_request.pyposthog/test/request.py renamed to posthog/test/test_request.py

@@ -21,11 +21,12 @@
         "black",
         "isort",
         "pre-commit",
+    ],
+    "test": [
+        "mock>=2.0.0", "freezegun==0.3.15", "pylint", "flake8", "coverage"
     ]
 }
 
-tests_require = ["mock>=2.0.0", "freezegun==0.3.15"]
-
 setup(
     name="posthog",
     version=VERSION,
@@ -39,7 +40,6 @@
     license="MIT License",
     install_requires=install_requires,
     extras_require=extras_require,
-    tests_require=tests_require,
     description="Integrate PostHog into any python application.",
     long_description=long_description,
     classifiers=[