Skip to content

Commit

Permalink
Initial development release candidate
Browse files Browse the repository at this point in the history
  • Loading branch information
mikeywaites committed Jul 4, 2016
0 parents commit 9e4cd8e
Show file tree
Hide file tree
Showing 30 changed files with 3,612 additions and 0 deletions.
55 changes: 55 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
# Byte-compiled / optimized / DLL files
__pycache__/
*.py[cod]

# C extensions
*.so

# Distribution / packaging
.Python
env/
build/
develop-eggs/
dist/
downloads/
eggs/
lib/
lib64/
parts/
sdist/
var/
*.egg-info/
.installed.cfg
*.egg

# PyInstaller
# Usually these files are written by a python script from a template
# before PyInstaller builds the exe, so as to inject date/other infos into it.
*.manifest
*.spec

# Installer logs
pip-log.txt
pip-delete-this-directory.txt

# Unit test / coverage reports
htmlcov/
.tox/
.coverage
.cache
nosetests.xml
coverage.xml

# Translations
*.mo
*.pot

# Django stuff:
*.log

# Sphinx documentation
docs/_build/

# PyBuilder
target/
.eggs
13 changes: 13 additions & 0 deletions Dockerfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
FROM python:3.5

RUN mkdir /opt/code
ADD . /opt/code
WORKDIR /opt/code

RUN pip install -U pip
RUN pip install -U setuptools
RUN pip install --editable .

VOLUME ["/opt/code"]

CMD ["python", "setup.py", "test"]
22 changes: 22 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
The MIT License (MIT)

Copyright (c) 2015 Mike Waites

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.

24 changes: 24 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
#flask-arrested
==============

A python REST API framework for flask

####What does flask-arrested offer me?

* Generic ApiResources (*views*) convering all HTTP methods as well as a function based api for the die hard flask fans.

* Well tested, robust API thats used heavily in production already.

* Best practice patterns for saving, retrieveing and manipulating data via a flexible hooks system

####What are the goals of flask-arrested?

* Provide a flexible well documented framework for rapidly building rest api endpoints in a re-usable and robust way.

* Don't make assumptions about the right or wrong way to write a rest api, simply provide a beautiful set of tools for getting things done with HTTP and flask

* Dont reinvent the wheel. Flask already handles HTTP amazingly - Simply provide the tools and components to make common patterns in rest easier and quicker to implement.

* Give users confidence. A framework whos offering is about speed and ease of use shouldn't shy form robustness and predictability. Offer a full suite of easily runnable tests covering the full code base.

* Extensible. Whilst not making assumptions about how users should implement auth or serilization etc, Still provide a lib of options that define best practice or 'go to tools' for getting things done.
12 changes: 12 additions & 0 deletions arrested/__init__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# flask_arrested/__init__.py
# Copyright (C) 2014-2015 the Flask-Arrested authors and contributors
# <see AUTHORS file>
#
# This module is part of Flask-Arrested and is released under
# the MIT License: http://www.opensource.org/licenses/mit-license.php

#flake8:NOQA


from .app import Arrested
from .api import Api
Loading

0 comments on commit 9e4cd8e

Please sign in to comment.