Initial commit

lovelydinosaur · lovelydinosaur · commit 92114701dc76 · 2016-07-07T10:48:30.000+01:00
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,10 @@
+env/
+dist/
+htmlcov/
+site/
+.tox/
+*.egg-info/
+*.pyc
+__pycache__
+.cache
+.coverage
diff --git a/.travis.yml b/.travis.yml
@@ -0,0 +1,12 @@
+language: python
+
+python:
+  - "2.7"
+  - "3.4"
+  - "3.5"
+
+install:
+    - pip install -r requirements.txt
+
+script:
+    - ./runtests
diff --git a/LICENSE.md b/LICENSE.md
@@ -0,0 +1,24 @@
+# License
+
+Copyright © 2016 Tom Christie
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+Redistributions of source code must retain the above copyright notice, this
+list of conditions and the following disclaimer.
+Redistributions in binary form must reproduce the above copyright notice, this
+list of conditions and the following disclaimer in the documentation and/or
+other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
diff --git a/README.md b/README.md
@@ -0,0 +1,18 @@
+# OpenAPI Codec
+
+**An OpenAPI codec for Core API.**
+
+[![travis-image]][travis]
+[![pypi-image]][pypi]
+
+## Installation
+
+Install using pip:
+
+    $ pip install openapi-codec
+
+
+[travis-image]: https://secure.travis-ci.org/encode/openapi-codec.svg?branch=master
+[travis]: http://travis-ci.org/encode/openapi-codec?branch=master
+[pypi-image]: https://img.shields.io/pypi/v/openapi-codec.svg
+[pypi]: https://pypi.python.org/pypi/openapi-codec
diff --git a/openapi_codec/__init__.py b/openapi_codec/__init__.py
@@ -0,0 +1 @@
+__version__ = "0.0.1"
diff --git a/requirements-unfrozen.txt b/requirements-unfrozen.txt
@@ -0,0 +1,4 @@
+# Testing requirements
+coverage
+flake8
+pytest
diff --git a/requirements.txt b/requirements.txt
diff --git a/runtests b/runtests
@@ -0,0 +1,89 @@
+#!/usr/bin/env python
+import coverage
+import os
+import pytest
+import subprocess
+import sys
+
+
+PYTEST_ARGS = ['tests', '--tb=short']
+FLAKE8_ARGS = ['openapi_codec', 'tests', '--ignore=E501']
+COVERAGE_OPTIONS = {
+    'include': ['openapi_codec/*', 'tests/*']
+}
+
+
+sys.path.append(os.path.dirname(__file__))
+
+
+class NullFile(object):
+    def write(self, data):
+        pass
+
+
+def exit_on_failure(ret, message=None):
+    if ret:
+        sys.exit(ret)
+
+
+def flake8_main(args):
+    print('Running flake8 code linting')
+    ret = subprocess.call(['flake8'] + args)
+    print('flake8 failed' if ret else 'flake8 passed')
+    return ret
+
+
+def report_coverage(cov, fail_if_not_100=False):
+    precent_covered = cov.report(
+        file=NullFile(), **COVERAGE_OPTIONS
+    )
+    if precent_covered == 100:
+        print('100% coverage')
+        return
+    if fail_if_not_100:
+        print('Tests passed, but not 100% coverage.')
+    cov.report(**COVERAGE_OPTIONS)
+    cov.html_report(**COVERAGE_OPTIONS)
+    if fail_if_not_100:
+        sys.exit(1)
+
+
+def split_class_and_function(string):
+    class_string, function_string = string.split('.', 1)
+    return "%s and %s" % (class_string, function_string)
+
+
+def is_function(string):
+    # `True` if it looks like a test function is included in the string.
+    return string.startswith('test_') or '.test_' in string
+
+
+def is_class(string):
+    # `True` if first character is uppercase - assume it's a class name.
+    return string[0] == string[0].upper()
+
+
+if __name__ == "__main__":
+    if len(sys.argv) > 1:
+        pytest_args = sys.argv[1:]
+        first_arg = pytest_args[0]
+        if first_arg.startswith('-'):
+            # `runtests.py [flags]`
+            pytest_args = PYTEST_ARGS + pytest_args
+        elif is_class(first_arg) and is_function(first_arg):
+            # `runtests.py TestCase.test_function [flags]`
+            expression = split_class_and_function(first_arg)
+            pytest_args = PYTEST_ARGS + ['-k', expression] + pytest_args[1:]
+        elif is_class(first_arg) or is_function(first_arg):
+            # `runtests.py TestCase [flags]`
+            # `runtests.py test_function [flags]`
+            pytest_args = PYTEST_ARGS + ['-k', pytest_args[0]] + pytest_args[1:]
+    else:
+        pytest_args = PYTEST_ARGS
+
+    cov = coverage.coverage()
+    cov.start()
+    exit_on_failure(pytest.main(pytest_args))
+    cov.stop()
+    exit_on_failure(flake8_main(FLAKE8_ARGS))
+    report_coverage(cov)
diff --git a/setup.py b/setup.py
@@ -0,0 +1,72 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+
+from setuptools import setup
+import re
+import os
+import sys
+
+
+def get_version(package):
+    """
+    Return package version as listed in `__version__` in `init.py`.
+    """
+    init_py = open(os.path.join(package, '__init__.py')).read()
+    return re.search("__version__ = ['\"]([^'\"]+)['\"]", init_py).group(1)
+
+
+def get_packages(package):
+    """
+    Return root package and all sub-packages.
+    """
+    return [dirpath
+            for dirpath, dirnames, filenames in os.walk(package)
+            if os.path.exists(os.path.join(dirpath, '__init__.py'))]
+
+
+def get_package_data(package):
+    """
+    Return all files under the root package, that are not in a
+    package themselves.
+    """
+    walk = [(dirpath.replace(package + os.sep, '', 1), filenames)
+            for dirpath, dirnames, filenames in os.walk(package)
+            if not os.path.exists(os.path.join(dirpath, '__init__.py'))]
+
+    filepaths = []
+    for base, filenames in walk:
+        filepaths.extend([os.path.join(base, filename)
+                          for filename in filenames])
+    return {package: filepaths}
+
+
+version = get_version('openapi_codec')
+
+
+if sys.argv[-1] == 'publish':
+    os.system("python setup.py sdist upload")
+    print("You probably want to also tag the version now:")
+    print("  git tag -a %s -m 'version %s'" % (version, version))
+    print("  git push --tags")
+    sys.exit()
+
+
+setup(
+    name='openapi-codec',
+    version=version,
+    url='http://github.com/encode/openapi-codec/',
+    license='BSD',
+    description='An OpenAPI codec for Core API.',
+    author='Tom Christie',
+    author_email='tom@tomchristie.com',
+    packages=get_packages('openapi_codec'),
+    package_data=get_package_data('openapi_codec'),
+    install_requires=[],
+    classifiers=[
+        'Intended Audience :: Developers',
+        'License :: OSI Approved :: BSD License',
+        'Operating System :: OS Independent',
+        'Programming Language :: Python',
+        'Programming Language :: Python :: 3',
+    ]
+)
diff --git a/tests/test_example.py b/tests/test_example.py
@@ -0,0 +1,2 @@
+def test_example():
+    assert True
diff --git a/tox.ini b/tox.ini
@@ -0,0 +1,5 @@
+[tox]
+envlist = py34,py27
+[testenv]
+deps = -rrequirements.txt
+commands = ./runtests

-Original file line number
+Diff line change
@@ @@ -0,0 +1,4 @@ @@
 +# Testing requirements
 +coverage
 +flake8
 +pytest
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+def test_example():`
	`2`	`+ assert True`