Wilson Xu avatar Wilson Xu committed 5d77b03

Updated README.rst.

Comments (0)

Files changed (2)

README

-Fbone is a Flask skeleton, with following dependencies.
-
-----
-
-Dependencies:
-
-Flask
-Flask-SQLAlchemy
-Flask-WTF
-Flask-Script
-Flask-Babel
-Flask-Testing
-Flask-Uploads
-Flask-Mail
-Flask-Cache
-Flask-Login
-
-HTML5 Boilerplate
-bootstrap
-jQuery
-
-nose
-
-----
-
-Commands:
-
-# Install packages.
-python setup.py install
-
-# Run local server.
-python manage.py run
-
-# Reset database.
-python manage.py reset
-
-# Compile with babel.
-python setup.py compile_catalog --directory fbone/translations --locale zh -f
-Requests: HTTP for Humans
-=========================
+Fbone: A Flask skeleton
+=======================
 
-Requests is an ISC Licensed HTTP library, written in Python, for human
-beings.
-
-Most existing Python modules for sending HTTP requests are extremely
-verbose and cumbersome. Python's builtin urllib2 module provides most of
-the HTTP capabilities you should need, but the api is thoroughly broken.
-It requires an enormous amount of work (even method overrides) to
-perform the simplest of tasks.
-
-Things shouldn't be this way. Not in Python.
-
-::
-
-    >>> r = requests.get('https://api.github.com', auth=('user', 'pass'))
-    >>> r.status_code
-    204
-    >>> r.headers['content-type']
-    'application/json'
-    >>> r.content
-    ...
-
-See `the same code, without Requests <https://gist.github.com/973705>`_.
-
-Requests allow you to send  **HEAD**, **GET**, **POST**, **PUT**,
-**PATCH**, and **DELETE** HTTP requests. You can add headers, form data,
-multipart files, and parameters with simple Python dictionaries, and access the
-response data in the same way. It's powered by httplib, but it does
-all the hard work and crazy hacks for you.
+Fbone is `Flask <http://flask.pocoo.org>`_ skeleton, which records how I learn and use Flask.
 
 
 Features
 --------
 
-- Extremely simple HEAD, GET, POST, PUT, PATCH, DELETE Requests.
-- Gevent support for Asyncronous Requests.
-- Sessions with cookie persistience.
-- Basic, Digest, and Custom Authentication support.
-- Automatic form-encoding of dictionaries
-- A simple dictionary interface for request/response cookies.
-- Multipart file uploads.
-- Automatc decoding of Unicode, gzip, and deflate responses.
-- Full support for unicode URLs and domain names.
+- Register, login, logout, remember me and reset password.
+- Use `twitter/bootstrap <https://github.com/twitter/bootstrap>`_ and `HTML5 Boilerplate <https://github.com/h5bp/html5-boilerplate>`_.
+- Handle forms with `WTForms <http://wtforms.simplecodes.com/>`_.
+- Handle database with `SQLAlchemy <http://www.sqlalchemy.org>`_.
+- `Deploy on Apache + mod_wsgi with fabric <http://flask.pocoo.org/docs/deploying/mod_wsgi/>`_.
+- i18n support with `Flask-Babel <http://packages.python.org/Flask-Babel/>`_.
+- Unit testing with `Flask-Testing <http://packages.python.org/Flask-Testing/>`_.
 
 
 Usage
 -----
 
-It couldn't be simpler. ::
+Install packages: ::
 
-    >>> import requests
-    >>> r = requests.get('http://google.com')
+    $ python setup.py install
 
+Run local server: ::
 
-HTTPS? Basic Authentication? ::
+    $ python manage.py run
 
-    >>> r = requests.get('https://httpbin.ep.io/basic-auth/user/pass')
-    >>> r.status_code
-    401
+Reset database: ::
 
+    $ python manage.py reset
 
-Uh oh, we're not authorized! Let's add authentication. ::
-
-    >>> r = requests.get('https://httpbin.ep.io/basic-auth/user/pass', auth=('user', 'pass'))
-
-    >>> r.status_code
-    200
-
-    >>> r.headers['content-type']
-    'application/json'
-
-    >>> r.content
-    '{"authenticated": true, "user": "user"}'
-
-
-Installation
-------------
-
-To install requests, simply: ::
-
-    $ pip install requests
-
-Or, if you absolutely must: ::
-
-    $ easy_install requests
-
-But, you really shouldn't do that.
-
-
-
-Contribute
-----------
-
-#. Check for open issues or open a fresh issue to start a discussion around a feature idea or a bug. There is a Contributor Friendly tag for issues that should be ideal for people who are not very familiar with the codebase yet.
-#. Fork `the repository`_ on Github to start making your changes to the **develop** branch (or branch off of it).
-#. Write a test which shows that the bug was fixed or that the feature works as expected.
-#. Send a pull request and bug the maintainer until it gets merged and published. :) Make sure to add yourself to AUTHORS_.
-
-.. _`the repository`: http://github.com/kennethreitz/requests
-.. _AUTHORS: http://github.com/kennethreitz/requests/blob/master/AUTHORS
+Compile with babel: ::
+    
+    $ python setup.py compile_catalog --directory fbone/translations --locale zh -f
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.