Merge pull request #2 from optimizely/add_contributing_instructions

Adding contributing instructions.

Author: aliabbasrizvi

CONTRIBUTING.md

@@ -0,0 +1,29 @@
+#Contributing to the Optimizely Python SDK
+We welcome contributions and feedback! Please read the [README](README.md) to set up your development environment, then read the guidelines below for information on submitting your code.
+
+##Development process
+
+1. Create a branch off of `master`: `git checkout -b YOUR_NAME/branch_name`.
+2. Commit your changes. Make sure to add tests!
+3. Lint your changes before submitting with `pep8 YOUR_CHANGED_FILES.py`.
+4. `git push` your changes to GitHub.
+5. Make sure that all unit tests are passing and that there are no merge conflicts between your branch and `master`.
+6. Open a pull request from `YOUR_NAME/branch_name` to `master`.
+7. A repository maintainer will review your pull request and, if all goes well, merge it!
+
+##Pull request acceptance criteria
+
+* **All code must have test coverage.** We use unittest. Changes in functionality should have accompanying unit tests. Bug fixes should have accompanying regression tests.
+  * Tests are located in `/tests` with one file per class.
+* Please don't change the `__version__`. We'll take care of bumping the version when we next release.
+* Lint your code with PEP-8 before submitting.
+
+##Style
+We enforce PEP-8 rules with a few minor deviations.
+
+##License
+
+By contributing your code, you agree to license your contribution under the terms of the [Apache License v2.0](http://www.apache.org/licenses/LICENSE-2.0).
+
+##Contact
+If you have questions, please contact [email protected].

README.md

@@ -1,65 +1,86 @@
-#Optimizely Python SDK 
-[![Apache 2.0](https://img.shields.io/github/license/nebula-plugins/gradle-extra-configurations-plugin.svg)](http://www.apache.org/licenses/LICENSE-2.0) 
+#Optimizely Python SDK
+[![Apache 2.0](https://img.shields.io/github/license/nebula-plugins/gradle-extra-configurations-plugin.svg)](http://www.apache.org/licenses/LICENSE-2.0)
 
-This Python SDK is an interface to the Optimizely testing framework allowing you to setup and manage your Custom experiments.
+This repository houses the Python SDK for Optimizely's server-side testing product, which is currently in private beta.
+
+##Getting Started
 
 ###Installing the SDK
 
-Build the SDK using the following command:
+The SDK is available through [PyPi](https://pypi.python.org/pypi?name=optimizely-sdk&:action=display). To install:
+
 ```
-python setup.py sdist
+pip install optimizely-sdk
 ```
 
-This will create a tarball under `dist/`
+###Using the SDK
+See the Optimizely server-side testing [developer documentation](http://developers.optimizely.com/server/reference/index) to learn how to set up your first custom project and use the SDK. **Please note that you must be a member of the private server-side testing beta to create custom projects and use this SDK.**
+
+##Development
+
+###Building the SDK
+
+Build the SDK using the following command:
 
-Install the SDK by typing the following command:
 ```
-pip install optimizely-testing-sdk-python-{VERSION}.tar.gz
+python setup.py sdist
 ```
 
-The install command will set up all requisite packages.
+This will create a tarball under `dist/`
 
-###Using the SDK
+You can then install the SDK and its dependencies with:
 
-Instructions on using the SDK can be found [here](http://developers.optimizely.com/server/reference/index).
+```
+pip install dist/optimizely-sdk-{VERSION}.tar.gz
+```
 
 ###Unit tests
 
-#####Run all tests
-You can trigger all unit tests by typing the following command:
+#####Running all tests
+You can run all unit tests with:
+
 ```
 nosetests
 ```
 
-#####Run all tests in file
-In order to run all tests under a particular test file you can run the following command:
+#####Running all tests in a file
+To run all tests under a particular test file you can use the following command:
+
 ```
 nosetests tests.<file_name_without_extension>
 ```
 
-For example to run all tests under `test_event`, the command would be:
+For example, to run all tests under `test_event`, the command would be:
+
 ```
 nosetests tests.test_event
 ```
 
-#####Run all tests under class
-In order to run all tests under a particular class of tests you can run the following command:
+#####Running all tests under a class
+To run all tests under a particular class of tests you can use the following command:
+
 ```
 nosetests tests.<file_name_without_extension>:ClassName
 ```
 
-For example to run all tests under `test_event.EventTest`, the command would be:
+For example, to run all tests under `test_event.EventTest`, the command would be:
 ```
 nosetests tests.test_event:EventTest
 ```
 
-#####Run single test
-In order to run one single test the command would be:
+#####Running a single test
+To run a single test you can use the following command:
+
 ```
 nosetests tests.<file_name_without_extension>:ClassName:test_name
 ```
 
-For example in order to run `test_event.EventTest.test_dispatch`, the command would be:
+For example, to run `test_event.EventTest.test_dispatch`, the command would be:
+
 ```
 nosetests tests.test_event:EventTest.test_dispatch
 ```
+
+###Contributing
+
+Please see [CONTRIBUTING](CONTRIBUTING.md).

setup.py

@@ -23,7 +23,7 @@
     description="A Python SDK for Optimizely's server-side testing product, which is currently in private beta.",
     author='Optimizely',
     author_email='[email protected]',
-    url='https://github.com/optimizely/optimizely-testing-sdk-python',
+    url='https://github.com/optimizely/python-sdk',
     license=open('LICENSE').read(),
     classifiers=[
       'Development Status :: 3 - Alpha',