README.rst 1.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657
  1. Gunicorn
  2. --------
  3. .. image::
  4. https://secure.travis-ci.org/benoitc/gunicorn.png?branch=master
  5. :alt: Build Status
  6. :target: https://travis-ci.org/benoitc/gunicorn
  7. Gunicorn 'Green Unicorn' is a Python WSGI HTTP Server for UNIX. It's a pre-fork
  8. worker model ported from Ruby's Unicorn_ project. The Gunicorn server is broadly
  9. compatible with various web frameworks, simply implemented, light on server
  10. resource usage, and fairly speedy.
  11. Feel free to join us in `#gunicorn`_ on Freenode_.
  12. Documentation
  13. -------------
  14. The documentation is hosted at http://docs.gunicorn.org.
  15. Installation
  16. ------------
  17. Gunicorn requires **Python 2.x >= 2.6** or **Python 3.x >= 3.2**.
  18. Install from PyPI::
  19. $ pip install gunicorn
  20. Usage
  21. -----
  22. Basic usage::
  23. $ gunicorn [OPTIONS] APP_MODULE
  24. Where ``APP_MODULE`` is of the pattern ``$(MODULE_NAME):$(VARIABLE_NAME)``. The
  25. module name can be a full dotted path. The variable name refers to a WSGI
  26. callable that should be found in the specified module.
  27. Example with test app::
  28. $ cd examples
  29. $ gunicorn --workers=2 test:app
  30. License
  31. -------
  32. Gunicorn is released under the MIT License. See the LICENSE_ file for more
  33. details.
  34. .. _Unicorn: http://unicorn.bogomips.org/
  35. .. _`#gunicorn`: http://webchat.freenode.net/?channels=gunicorn
  36. .. _Freenode: http://freenode.net
  37. .. _LICENSE: http://github.com/benoitc/gunicorn/blob/master/LICENSE