merge upstream changes

jimlyndon · Sep 11, 2014 · 7e224aa · 7e224aa
2 parents 9bd50b3 + c991a87
commit 7e224aa
Show file tree

Hide file tree

Showing 12 changed files with 381 additions and 252 deletions.
diff --git a/.gitignore b/.gitignore
@@ -2,4 +2,5 @@
 dist
 build
 *.egg-info
-.pypirc
+.pypirc
+docs/_build
diff --git a/3RDPARTYLICENSES → 3RDPARTYLICENSES.md b/3RDPARTYLICENSES → 3RDPARTYLICENSES.md
diff --git a/CONTRIBUTORS.md b/CONTRIBUTORS.md
@@ -0,0 +1,7 @@
+[Josh Bothun](https://github.com/minism)
+[Kyle Rimkus](https://github.com/krimkus)
+[Florian Ilgenfritz]([email protected])
+[Jonathan Liuti](https://github.com/johnraz)
+[David Wolever]([email protected])
+[Joshua Kehn](https://github.com/joshkehn)
+[David Miller]([email protected])
diff --git a/LICENSE b/LICENSE
diff --git a/LICENSE.md b/LICENSE.md
@@ -0,0 +1,13 @@
+Copyright © Concentric Sky, Inc. 
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
diff --git a/README.md b/README.md
@@ -0,0 +1,88 @@
+![Concentric Sky](https://concentricsky.com/media/uploads/images/csky_logo.jpg)
+
+## Django Tastypie Swagger
+
+**django-tastypie-swagger** is a small adapter library to construct [Swagger](http://swagger.wordnik.com/) documentation from [Tastypie](https://django-tastypie.readthedocs.org) resources.
+
+This package provides two things:
+
+1. An embedded instance of [Swagger UI](https://github.com/wordnik/swagger-ui) to point a URL to.
+2. Automatic [Resource Listing](https://github.com/wordnik/swagger-core/wiki/Resource-Listing) and [API Declaration](https://github.com/wordnik/swagger-core/wiki/API-Declaration) generation that is consumed by #1
+
+
+### Table of Contents
+- [Version History](#version-history)
+- [Documentation](#documentation)
+- [Installation](#installation)
+- [Getting Started](#getting-started)
+- [Contributors](#contributors)
+- [License](#license)
+- [About Concentric Sky](#about-concentric-sky)
+
+
+## Version History
+
+- v0.1.3 Various bug fixes and documentation updates
+- v0.1.2 Fixes for Django 1.5 compatibility
+- v0.1.1 Public codebase was released
+
+
+## Documentation
+
+Detailed documentation is available on [Read The Docs](http://django-tastypie-swagger.readthedocs.org/en/latest/).
+
+
+## Installation
+
+Install package::
+
+    pip install django-tastypie-swagger
+
+Add to INSTALLED_APPS::
+
+    INSTALLED_APPS = [
+        ...
+
+        'tastypie_swagger',
+
+        ...
+    ]
+
+
+## Getting Started
+
+Enable documentation for an api endpoint by adding a URL to your urlpatterns.
+
+eg::
+
+
+    urlpatterns = patterns('',
+        ...
+
+        url(r'api/myapi/doc/',
+          include('tastypie_swagger.urls', namespace='myapi_tastypie_swagger'),
+          kwargs={"tastypie_api_module":"myapp.registration.my_api", "namespace":"myapi_tastypie_swagger"}
+        ),
+
+        ...
+    )
+
+
+To declare more than one endpoint, repeat the above URL definition and change the namespace.
+
+Swagger documentation will be served up at the URL(s) you configured.
+
+
+## Contributors
+
+Contributors to this project are listed in the CONTRIBUTORS.md file. If you contribute to this project, please add your name to the file.
+
+
+## License
+
+This project is licensed under the Apache License, Version 2.0. Details can be found in the LICENSE.md file. License for third-party code is available in 3RDPARTYLICENSES.md.
+
+
+## About Concentric Sky
+
+_For nearly a decade, Concentric Sky has been building technology solutions that impact people everywhere. We work in the mobile, enterprise and web application spaces. Our team, based in Eugene Oregon, loves to solve complex problems. Concentric Sky believes in contributing back to our community and one of the ways we do that is by open sourcing our code on GitHub. Contact Concentric Sky at [email protected]._
diff --git a/README.rst b/README.rst
diff --git a/docs/conf.py b/docs/conf.py
@@ -47,7 +47,7 @@
 
 # General information about the project.
 project = u'Django Tastypie Swagger'
-copyright = u'2014, Kyle Rimkus, Josh Bothun'
+copyright = u'2014, Concentric Sky, Inc.'
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
@@ -56,7 +56,7 @@
 # The short X.Y version.
 version = '0.1'
 # The full version, including alpha/beta/rc tags.
-release = '0.1.2'
+release = '0.1.3'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.