5e7030022c
This patch includes the index page and a user guide. The user guide is mostly finished, but still needs some love. There are also placeholders on the index page for other sections that need to be filled out.
1.8 KiB
Installation
Install from PyPI
Falcon is super easy to install with pip. If you don't have pip yet, please run—don't walk—on over to the pip website and get that happy little tool installed before you do anything else.
If available, Falcon will compile itself with Cython for an extra speed boost. The following will make sure Cython is installed first, and that you always have the latest and greatest
$ pip install --upgrade cython falconIf you are on PyPy, you won't need Cython, of course:
$ pip install --upgrade falconWSGI Server
Falcon speaks WSGI. If you want to actually serve a Falcon app, you will want a good WSGI server. I like Gunicorn and uWSGI, but anything that can load a WSGI app will do. Gevent is an async library that works well with both Gunicorn and uWSGI.
$ pip install --upgrade gevent [gunicorn|uwsgi]Source Code
Falcon lives on GitHub., making the code easy to browse, download, fork, etc. Pull requests are always welcome! Also, please remember to star the project if it makes you happy.
Once you have cloned the repro or downloaded a tarball from GitHub, you can install Falcon like this:
$ cd falcon
$ pip install .Or, if you want to edit the code, first fork the main repo, clone the fork to your desktop, and then run the following to install it using symbolic linking, so that when you change your code, the changes will be automagically available to your app without having to reinstall the package:
$ cd falcon
$ pip install -e .Did we mention we love pull requests? :)