Merge branch 'release-0.1.6'

.gitignore

@@ -55,3 +55,7 @@ docs/_build/
 
 # Vim
 *.swp
+
+# InteliJ
+.idea/
+

.travis.yml

@@ -7,7 +7,6 @@ python:
   - "2.6"
   - "3.2"
   - "3.3"
-  - "3.4"
 
 # command to install dependencies, e.g. pip install -r requirements.txt --use-mirrors
 install: 

HISTORY.rst

@@ -3,6 +3,12 @@
 History
 -------
 
+0.1.6 (2015-09-04)
+++++++++++++++++++
+
+* Updated documentation
+
+
 0.1.5 (2015-31-03)
 ++++++++++++++++++
 

LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2014 Jakub Jarosz
+Copyright (c) 2014-2015 Jakub Jarosz
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

Makefile

@@ -0,0 +1,56 @@
+.PHONY: help clean clean-pyc clean-build list test test-all coverage docs release sdist
+
+help:
+	@echo "clean-build - remove build artifacts"
+	@echo "clean-pyc - remove Python file artifacts"
+	@echo "lint - check style with flake8"
+	@echo "test - run tests quickly with the default Python"
+	@echo "testall - run tests on every Python version with tox"
+	@echo "coverage - check code coverage quickly with the default Python"
+	@echo "docs - generate Sphinx HTML documentation, including API docs"
+	@echo "release - package and upload a release"
+	@echo "sdist - package"
+
+clean: clean-build clean-pyc
+
+clean-build:
+	rm -fr build/
+	rm -fr dist/
+	rm -fr *.egg-info
+
+clean-pyc:
+	find . -name '*.pyc' -exec rm -f {} +
+	find . -name '*.pyo' -exec rm -f {} +
+	find . -name '*~' -exec rm -f {} +
+
+lint:
+	flake8 circleclient test
+
+test:
+	py.test
+
+test-all:
+	tox
+
+coverage:
+	coverage run --source circleclient setup.py test
+	coverage report -m
+	coverage html
+	open htmlcov/index.html
+
+docs:
+	rm -f docs/circleclient.rst
+	rm -f docs/modules.rst
+	sphinx-apidoc -o docs/ circleclient
+	$(MAKE) -C docs clean
+	$(MAKE) -C docs html
+	open docs/_build/html/index.html
+
+release: clean
+	python setup.py sdist upload
+	python setup.py bdist_wheel upload
+
+sdist: clean
+	python setup.py sdist
+	python setup.py bdist_wheel 
+	ls -l dist

README.rst

@@ -10,14 +10,16 @@ circleclient
     :target: https://pypi.python.org/pypi/circleclient
     :alt: Latest Version
 
-.. image:: https://pypip.in/d/circleclient/badge.png
-    :target: https://pypi.python.org/pypi/circleclient
-    :alt: Downloads
-
 .. image:: https://pypip.in/license/circleclient/badge.png
     :target: https://pypi.python.org/pypi/circleclient/
     :alt: License
 
+.. image:: https://pypip.in/d/circleclient/badge.png
+    :target: https://crate.io/packages/circleclient?version=latest
+    :alt: Downloads
+
+
+
 Python client library for CircleCI API.
 
 Features

circleclient/circleclient.py

@@ -4,7 +4,7 @@
 import requests
 
 
-__version__ = '0.1.5'
+__version__ = '0.1.6'
 
 
 class CircleClient(object):

docs/circleclient.rst

@@ -0,0 +1,22 @@
+circleclient package
+====================
+
+Submodules
+----------
+
+circleclient.circleclient module
+--------------------------------
+
+.. automodule:: circleclient.circleclient
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: circleclient
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/conf.py

@@ -12,7 +12,8 @@
 # serve to show the default.
 
 import sys, os
-import sphinx_rtd_theme
+#import sphinx_rtd_theme
+
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
@@ -47,7 +48,7 @@
 
 # General information about the project.
 project = u'circleclient'
-copyright = u'2014, Jakub Jarosz'
+copyright = u'2015, Jakub Jarosz'
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
@@ -100,16 +101,16 @@
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
-#html_theme = 'default'
-html_theme = 'sphinx_rtd_theme'
+html_theme = 'default'
+#html_theme = 'sphinx_rtd_theme'
 
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the
 # documentation.
 #html_theme_options = {}
 
 # Add any paths that contain custom themes here, relative to this directory.
-html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
+#html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
 
 # The name for this set of Sphinx documents.  If None, it defaults to
 # "<project> v<release> documentation".

docs/modules.rst

@@ -0,0 +1,7 @@
+circleclient
+============
+
+.. toctree::
+   :maxdepth: 4
+
+   circleclient

setup.py

@@ -8,43 +8,46 @@
 import sys
 
 from setuptools import setup, find_packages
-from codecs import open
 
 
-this_dir = os.path.abspath(os.path.dirname(__file__))
+readme = open('README.rst').read()
+doclink = """
+Documentation
+-------------
 
-with open(os.path.join(this_dir, 'README.rst'), encoding='utf-8') as f:
-    LONG_DESCRIPTION = '\n' + f.read()
+The full documentation is at http://circleclient.rtfd.org."""
+history = open('HISTORY.rst').read().replace('.. :changelog:', '')
 
 
 setup(
     name='circleclient',
-    version='0.1.5',
+    version='0.1.6',
     author='Jakub Jarosz',
     author_email='qba73@postpro.net',
     description='Python client for CircleCI API',
-    long_description=LONG_DESCRIPTION,
+    long_description=readme + '\n\n' + doclink + '\n\n' + history,
     url='http://github.com/qba73/circleclient/',
-    packages=find_packages(exclude=['contrib', 'docs', 'tests*']),
+    packages=[
+        'circleclient'
+    ],
+    package_dir={'circleclient': 'circleclient'},
+    include_package_data=True,
+    install_requires=['requests'],
     license='MIT',
-    keywords=['ci', 'testing', 'qa'],
+    zip_safe=False,
+    keywords=['ci', 'testing', 'qa', 'circleclient'],
     classifiers=[
         'Development Status :: 3 - Alpha',
         'Environment :: Console',
         'Intended Audience :: Developers',
         'License :: OSI Approved :: MIT License',
         'Natural Language :: English',
-        'Operating System :: OS Independent',
         'Programming Language :: Python :: 2',
-        'Programming Language :: Python :: 2.6',
         'Programming Language :: Python :: 2.7',
         'Programming Language :: Python :: 3',
         'Programming Language :: Python :: 3.3',
         'Programming Language :: Python :: 3.4',
-        'Topic :: Software Development :: Libraries',
-        'Topic :: Software Development :: Libraries :: Python Modules',
         'Topic :: Software Development :: Testing',
         'Topic :: Software Development :: Quality Assurance'
     ],
-    install_requires=['requests'],
 )