8000 Release v1.0 by jacebrowning · Pull Request #83 · flask-api/flask-api · GitHub
[go: up one dir, main page]
Skip to content

Release v1.0 #83

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 13 commits into from
Aug 29, 2017
Merged

Release v1.0 #83

Changes from 1 commit
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
9874a2f
Customize automatic API return types
jacebrowning Apr 12, 2017
f288095
Add initial support for pipenv
jacebrowning Apr 12, 2017
05a0713
Update CI tooling
jacebrowning Aug 21, 2017
26d7dcf
Test against the latest versions of Flask
jacebrowning Aug 21, 2017
838fe8b
Add scrutinizer config
jacebrowning Aug 21, 2017
53e97af
Update status
jacebrowning Aug 22, 2017
57ac3d0
Link to API Star
jacebrowning Aug 22, 2017
4221387
Add contributor instructions
jacebrowning Aug 22, 2017
5be9eea
Update docs for 1.0 release
jacebrowning Aug 22, 2017
8d097ef
Upload packages with twine
jacebrowning Aug 22, 2017
79ecbea
Fix merge conflict
jacebrowning Aug 22, 2017
27f4228
Bump version to 1.0
jacebrowning Aug 29, 2017
cdf8eec
Update repository location
jacebrowning Aug 29, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Update status
  • Loading branch information
@jacebrowning
jacebrowning committed Aug 22, 2017
commit 53e97af55aae1f4f76eaa358d8c23e07d5620b01
54 changes: 8 additions & 46 deletions README.md
View file
Open in desktop
980B
Original file line number Diff line number Diff line change
@@ -1,42 +1,20 @@
**Status**: Flask API is not currently under active development. This will be reassessed once the [Django REST framework](https://github.com/tomchristie/django-rest-framework) Kickstarter project reaches completion.
# Flask API

# [Flask API](http://www.flaskapi.org)
Browsable web APIs for Flask.

Browsable Web APIs for Flask - <http://www.flaskapi.org>
[![Unix Build Status](https://img.shields.io/travis/flask-api/flask-api.svg)](https://travis-ci.org/flask-api/flask-api)
[![Coverage Status](https://img.shields.io/coveralls/flask-api/flask-api.svg)](https://coveralls.io/r/flask-api/flask-api)
[![Scrutinizer Code Quality](https://img.shields.io/scrutinizer/g/flask-api/flask-api.svg)](https://scrutinizer-ci.com/g/flask-api/flask-api/)
[![PyPI Version](https://img.shields.io/pypi/v/Flask-API.svg)](https://pypi.org/project/Flask-API/)

[![Build Status][travis-image]][travis-link]
[![Coverage Status][coveralls-image]][coveralls-link]
[![PyPI Version][pypi-image]][pypi-link]

---
**Status**: This project is in maintenance mode. The original author ([Tom Christie](https://twitter.com/_tomchristie)) has shifted their focus to a more general-purpose API project: http://www.coreapi.org. Passing PRs will still be considered for releases by the maintainers ([Jace Browning](https://twitter.com/jacebrowning)).

## Overview

Flask API is an implementation of the same web browsable APIs that [Django REST framework][django-rest-framework] provides.

It gives you properly content negotiated responses and smart request parsing.

It is currently a work in progress, but the fundamentals are in place and you can already start building kick-ass browsable Web APIs with it. If you want to start using Flask API right now go ahead and do so, but be sure to follow the release notes of new versions carefully.
Flask API is a drop-in replacement for Flask that provides implementation of browsable APIs similar to what [Django REST framework](http://www.django-rest-framework.org) provides. It gives you properly content negotiated responses and smart request parsing:

![Screenshot](docs/screenshot.png)

## Roadmap

Future work on getting Flask API to a 1.0 release will include:

* Authentication, including session, basic and token authentication.
* Permissions, including a simple user-is-authenticated permission.
* Throttling, including a base rate throttling implementation.
* Support for using class based views, including the base view class.
* Browsable API improvements, such as breadcrumb generation.
* Customizable exception handling.
* CSRF protection for session authenticated requests.
* Login and logout views for the browsable API.
* Documentation on how to deal with request validation.
* Documentation on how to deal with hyperlinking.

It is also possible that the core of Flask API could be refactored into an external dependency, in order to make browsable APIs easily available to any Python web framework.

## Installation

Requirements:
Expand Down Expand Up @@ -149,19 +127,3 @@ You can now open a new tab and interact with the API from the command line:
{"url": "http://127.0.0.1:5000/1/", "text": "flask api is teh awesomez"}

You can also work on the API directly in your browser, by opening <http://127.0.0.1:5000/>. You can then navigate between notes, and make `GET`, `PUT`, `POST` and `DELETE` API requests.

## Credits

To stay up to date with progress on Flask API, follow [Tom Christie on twitter][tomchristie].

Many thanks to [Nicolas Clairon][nicolas-clarion] for making the `flask_api` PyPI package available.

[travis-image]: http://img.shields.io/travis/flask-api/flask-api/master.svg
[travis-link]: https://travis-ci.org/flask-api/flask-api
[coveralls-image]: http://img.shields.io/coveralls/flask-api/flask-api/master.svg
[coveralls-link]: https://coveralls.io/r/flask-api/flask-api?branch=master
[pypi-image]: http://img.shields.io/pypi/v/flask-api.svg
[pypi-link]: https://pypi.python.org/pypi/flask-api
[django-rest-framework]: http://www.django-rest-framework.org
[tomchristie]: https://twitter.com/_tomchristie
[nicolas-clarion]: https://github.com/namlook/
0