diff --git a/.gitignore b/.gitignore index 6d9a4ec..a460d45 100644 --- a/.gitignore +++ b/.gitignore @@ -3,6 +3,8 @@ # Packaging files: *.egg* +dist +MANIFEST # Editor temp files: *.swp diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..0ecbf21 --- /dev/null +++ b/LICENSE @@ -0,0 +1,7 @@ +Copyright (C) 2014 Tomas Rychlik + +Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. \ No newline at end of file diff --git a/MANIFEST.in b/MANIFEST.in new file mode 100644 index 0000000..b1eaf85 --- /dev/null +++ b/MANIFEST.in @@ -0,0 +1,2 @@ +include README.rst +include LICENSE \ No newline at end of file diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..f16eb9a --- /dev/null +++ b/README.rst @@ -0,0 +1,24 @@ +django-jsonis +============= + +Helper library that can be used in combination with Django Class-Based views to return JSON responses. + +Features +-------- +- JSONApiResponseMixin providing render_api_response and render_api_error_response methods +- Accepting JSON encoding of POST request body +- JSONApiFormView that can be used for simple JSON APIs using django.forms +- JSON Web token validation (pending to be moved into separate package) +- JSONTestClient providing utilities taht can be used to test created APIs +- Default JSONEncoder handling Decimal numbers +- Simple jsonify template tag (you will need to install jsonis) + +License +------- +This software is licensed under MIT. + +TODO +---- +- Documentation +- Code Cleanup +- Tests \ No newline at end of file diff --git a/setup.py b/setup.py index 5756c0b..3fff301 100644 --- a/setup.py +++ b/setup.py @@ -4,15 +4,15 @@ setup( name='django-jsonis', - version='0.1.0', + version='0.1.1', description='Django JSON Utils', author='Tomas Rychlik', author_email='rychlis@rychlis.cz', - packages=['jsonis'], + packages=['jsonis', 'jsonis.templatetags'], license='MIT', - install_requires=[ - 'Django==1.6.3', - 'PyJWT==0.1.6' + requires=[ + 'Django(>=1.4.0,<1.7)', + 'PyJWT(>=0.1.6,<0.2)' ], classifiers=[ 'Intended Audience :: Developers',