Merge pull request #14 from blancltd/12-pypi-integration

Prep work for PyPi integration

CONTRIBUTING.rst

@@ -0,0 +1,114 @@
+.. highlight:: shell
+
+============
+Contributing
+============
+
+Contributions are welcome, and they are greatly appreciated! Every
+little bit helps, and credit will always be given.
+
+You can contribute in many ways:
+
+Types of Contributions
+----------------------
+
+Report Bugs
+~~~~~~~~~~~
+
+Report bugs at https://github.com/blancltd/cofecms/issues.
+
+If you are reporting a bug, please include:
+
+* Your operating system name and version.
+* Any details about your local setup that might be helpful in troubleshooting.
+* Detailed steps to reproduce the bug.
+
+Fix Bugs
+~~~~~~~~
+
+Look through the GitHub issues for bugs. Anything tagged with "bug"
+and "help wanted" is open to whoever wants to implement it.
+
+Implement Features
+~~~~~~~~~~~~~~~~~~
+
+Look through the GitHub issues for features. Anything tagged with "enhancement"
+and "help wanted" is open to whoever wants to implement it.
+
+Write Documentation
+~~~~~~~~~~~~~~~~~~~
+
+pycofecms could always use more documentation, whether as part of the
+official pycofecms docs, in docstrings, or even on the web in blog posts,
+articles, and such.
+
+Submit Feedback
+~~~~~~~~~~~~~~~
+
+The best way to send feedback is to file an issue at https://github.com/blancltd/cofecms/issues.
+
+If you are proposing a feature:
+
+* Explain in detail how it would work.
+* Keep the scope as narrow as possible, to make it easier to implement.
+* Remember that this is a volunteer-driven project, and that contributions
+  are welcome :)
+
+Get Started!
+------------
+
+Ready to contribute? Here's how to set up `cofecms` for local development.
+
+1. Fork the `cofecms` repo on GitHub.
+2. Clone your fork locally::
+
+    $ git clone [email protected]:your_name_here/cofecms.git
+
+3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development::
+
+    $ mkvirtualenv cofecms
+    $ cd cofecms/
+    $ python setup.py develop
+
+4. Create a branch for local development::
+
+    $ git checkout -b name-of-your-bugfix-or-feature
+
+   Now you can make your changes locally.
+
+5. When you're done making changes, check that your changes pass flake8 and the tests, including testing other Python versions with tox::
+
+    $ flake8 cofecms tests
+    $ python setup.py test or py.test
+    $ tox
+
+   To get flake8 and tox, just pip install them into your virtualenv.
+
+6. Commit your changes and push your branch to GitHub::
+
+    $ git add .
+    $ git commit -m "Your detailed description of your changes."
+    $ git push origin name-of-your-bugfix-or-feature
+
+7. Submit a pull request through the GitHub website.
+
+Pull Request Guidelines
+-----------------------
+
+Before you submit a pull request, check that it meets these guidelines:
+
+1. The pull request should include tests.
+2. If the pull request adds functionality, the docs should be updated. Put
+   your new functionality into a function with a docstring, and add the
+   feature to the list in README.rst.
+3. The pull request should work for Python 2.6, 2.7, 3.3, 3.4 and 3.5, and for PyPy. Check
+   https://travis-ci.org/blancltd/cofecms/pull_requests
+   and make sure that the tests pass for all supported Python versions.
+
+Tips
+----
+
+To run a subset of tests::
+
+$ py.test tests.test_cofecms
+

HISTORY.rst

@@ -0,0 +1,8 @@
+=======
+History
+=======
+
+0.1.0 (2017-03-20)
+------------------
+
+* First release on PyPI.

MANIFEST.in

@@ -1 +1,11 @@
-recursive-include cofecms *.py
+
+include CONTRIBUTING.rst
+include HISTORY.rst
+include LICENSE
+include README.rst
+
+recursive-include tests *
+recursive-exclude * __pycache__
+recursive-exclude * *.py[co]
+
+recursive-include docs *.rst conf.py Makefile make.bat *.jpg *.png *.gif

Makefile

@@ -0,0 +1,87 @@
+.PHONY: clean clean-test clean-pyc clean-build docs help
+.DEFAULT_GOAL := help
+define BROWSER_PYSCRIPT
+import os, webbrowser, sys
+try:
+	from urllib import pathname2url
+except:
+	from urllib.request import pathname2url
+
+webbrowser.open("file://" + pathname2url(os.path.abspath(sys.argv[1])))
+endef
+export BROWSER_PYSCRIPT
+
+define PRINT_HELP_PYSCRIPT
+import re, sys
+
+for line in sys.stdin:
+	match = re.match(r'^([a-zA-Z_-]+):.*?## (.*)$$', line)
+	if match:
+		target, help = match.groups()
+		print("%-20s %s" % (target, help))
+endef
+export PRINT_HELP_PYSCRIPT
+BROWSER := python -c "$$BROWSER_PYSCRIPT"
+
+help:
+	@python -c "$$PRINT_HELP_PYSCRIPT" < $(MAKEFILE_LIST)
+
+clean: clean-build clean-pyc clean-test ## remove all build, test, coverage and Python artifacts
+
+
+clean-build: ## remove build artifacts
+	rm -fr build/
+	rm -fr dist/
+	rm -fr .eggs/
+	find . -name '*.egg-info' -exec rm -fr {} +
+	find . -name '*.egg' -exec rm -f {} +
+
+clean-pyc: ## remove Python file artifacts
+	find . -name '*.pyc' -exec rm -f {} +
+	find . -name '*.pyo' -exec rm -f {} +
+	find . -name '*~' -exec rm -f {} +
+	find . -name '__pycache__' -exec rm -fr {} +
+
+clean-test: ## remove test and coverage artifacts
+	rm -fr .tox/
+	rm -f .coverage
+	rm -fr htmlcov/
+
+lint: ## check style with flake8
+	flake8 cofecms tests
+
+test: ## run tests quickly with the default Python
+	py.test
+
+
+test-all: ## run tests on every Python version with tox
+	tox
+
+coverage: ## check code coverage quickly with the default Python
+	coverage run --source cofecms -m pytest
+
+		coverage report -m
+		coverage html
+		$(BROWSER) htmlcov/index.html
+
+docs: ## generate Sphinx HTML documentation, including API docs
+	rm -f docs/pycofecms.rst
+	rm -f docs/modules.rst
+	sphinx-apidoc -o docs/ cofecms
+	$(MAKE) -C docs clean
+	$(MAKE) -C docs html
+
+servedocs: docs ## compile the docs watching for changes
+	watchmedo shell-command -p '*.rst' -c '$(MAKE) -C docs html' -R -D .
+
+release: clean ## package and upload a release
+	python setup.py sdist upload
+	python setup.py bdist_wheel upload
+
+dist: clean ## builds source and wheel package
+	python setup.py sdist
+	python setup.py bdist_wheel
+	ls -l dist
+
+install: clean ## install the package to the active Python's site-packages
+	python setup.py install

README.rst

@@ -2,7 +2,14 @@
 Church of England CMS API Client
 ================================
 
-https://cmsapi.cofeportal.org/
+
+.. image:: https://img.shields.io/pypi/v/pycofecms.svg
+        :target: https://pypi.python.org/pypi/pycofecms
+
+.. image:: https://readthedocs.org/projects/pycofecms/badge/?version=latest
+        :target: https://pycofecms.readthedocs.io/en/latest/?badge=latest
+        :alt: Documentation Status
+
 
 Before you start, make sure you have access credentials for the Church of England CMS API. You will
 need a valid `API_ID` and `API_KEY`. See https://cmsapi.cofeportal.org/security for more
@@ -12,6 +19,18 @@ Most of the endpoints also require a `diocese_id`. You should be supplied with t
 receive your access credentials.
 
 
+* Free software: BSD license
+* Documentation: https://pycofecms.readthedocs.io
+
+
+Features
+========
+
+* Python client for the CofE CMS API (https://cmsapi.cofeportal.org/)
+* Python 3.5
+* 100% test coverage
+
+
 Quick Start
 ===========
 

cofecms/__init__.py

@@ -1,6 +1,10 @@
 import cofecms.api
 from cofecms.api import CofeCMS  # noqa
 
+__author__ = 'Blanc Ltd.'
+__email__ = '[email protected]'
+__version__ = '0.1.0'
+
 PLACE_TYPE_ARCHDEACONRY = cofecms.api.PLACE_TYPE_ARCHDEACONRY
 PLACE_TYPE_BENEFICE = cofecms.api.PLACE_TYPE_BENEFICE
 PLACE_TYPE_CHURCH = cofecms.api.PLACE_TYPE_CHURCH

cofecms/api.py

@@ -447,7 +447,7 @@ def do_request(self, endpoint_url, request_params):
             endpoint_url: The absolute URL for the endpoint to use. For example:
                 https://cmsapi.cofeportal.org/v2/contacts
             request_params: A dict containing the GET params for this request. Will be URL encoded
-            for you.
+                for you.
 
         Returns:
             An unmolested requests.Result object.