README.rst 1.6 KB

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