Skip to content

Commit 9e4cd8e

Browse files
committed
Initial development release candidate
0 parents  commit 9e4cd8e

30 files changed

+3612
-0
lines changed

.gitignore

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
# Byte-compiled / optimized / DLL files
2+
__pycache__/
3+
*.py[cod]
4+
5+
# C extensions
6+
*.so
7+
8+
# Distribution / packaging
9+
.Python
10+
env/
11+
build/
12+
develop-eggs/
13+
dist/
14+
downloads/
15+
eggs/
16+
lib/
17+
lib64/
18+
parts/
19+
sdist/
20+
var/
21+
*.egg-info/
22+
.installed.cfg
23+
*.egg
24+
25+
# PyInstaller
26+
# Usually these files are written by a python script from a template
27+
# before PyInstaller builds the exe, so as to inject date/other infos into it.
28+
*.manifest
29+
*.spec
30+
31+
# Installer logs
32+
pip-log.txt
33+
pip-delete-this-directory.txt
34+
35+
# Unit test / coverage reports
36+
htmlcov/
37+
.tox/
38+
.coverage
39+
.cache
40+
nosetests.xml
41+
coverage.xml
42+
43+
# Translations
44+
*.mo
45+
*.pot
46+
47+
# Django stuff:
48+
*.log
49+
50+
# Sphinx documentation
51+
docs/_build/
52+
53+
# PyBuilder
54+
target/
55+
.eggs

Dockerfile

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
FROM python:3.5
2+
3+
RUN mkdir /opt/code
4+
ADD . /opt/code
5+
WORKDIR /opt/code
6+
7+
RUN pip install -U pip
8+
RUN pip install -U setuptools
9+
RUN pip install --editable .
10+
11+
VOLUME ["/opt/code"]
12+
13+
CMD ["python", "setup.py", "test"]

LICENSE

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
The MIT License (MIT)
2+
3+
Copyright (c) 2015 Mike Waites
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.
22+

README.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
#flask-arrested
2+
==============
3+
4+
A python REST API framework for flask
5+
6+
####What does flask-arrested offer me?
7+
8+
* Generic ApiResources (*views*) convering all HTTP methods as well as a function based api for the die hard flask fans.
9+
10+
* Well tested, robust API thats used heavily in production already.
11+
12+
* Best practice patterns for saving, retrieveing and manipulating data via a flexible hooks system
13+
14+
####What are the goals of flask-arrested?
15+
16+
* Provide a flexible well documented framework for rapidly building rest api endpoints in a re-usable and robust way.
17+
18+
* 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
19+
20+
* 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.
21+
22+
* 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.
23+
24+
* 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.

arrested/__init__.py

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# flask_arrested/__init__.py
2+
# Copyright (C) 2014-2015 the Flask-Arrested authors and contributors
3+
# <see AUTHORS file>
4+
#
5+
# This module is part of Flask-Arrested and is released under
6+
# the MIT License: http://www.opensource.org/licenses/mit-license.php
7+
8+
#flake8:NOQA
9+
10+
11+
from .app import Arrested
12+
from .api import Api

0 commit comments

Comments
 (0)