PageRenderTime 220ms CodeModel.GetById 25ms RepoModel.GetById 1ms app.codeStats 0ms

/README.rst

https://github.com/marcelnicolay/torneira
ReStructuredText | 69 lines | 47 code | 22 blank | 0 comment | 0 complexity | 9833bdf2be751ed5ad5483e81b3a4eb4 MD5 | raw file
    

  1. Torneira - Lightweight Web Framework
    2. 

  2. ====================================
    3. 

  3. 

  4. Torneira is a lightweight web framework build on top of Tornado_. It's name
    5. 

  5. came from the idea of getting rapid and fluid development ('torneira' is the
    6. 

  6. portuguese word for water tap).
    7. 

  7. 

  8. .. image:: https://secure.travis-ci.org/marcelnicolay/torneira.png?branch=master
    9. 

  9.    :alt: Build Status
    10. 

  10.    :target: https://secure.travis-ci.org/marcelnicolay/torneira
    11. 

  11. 

  12. Installation
    13. 

  13. ------------
    14. 

  14. 

  15. Torrneira is available under PyPI_. You can install using pip:
    16. 

  16. 

  17.     $ pip install torneira
    18. 

  18. 

  19. Quick start
    20. 

  20. -----------
    21. 

  21. 

  22. To build an app using torneira, you just need 3 files: one for your urls
    23. 

  23. definitions (normally urls.py), one for settings (settings.py) and another for
    24. 

  24. your handlers (handlers.py). The Application and HTTPServer stuff is already
    25. 

  25. setup to you.
    26. 

  26. 

  27. To start the server on por 8888, just run the following command in the base
    28. 

  28. directory of your app:
    29. 

  29. 

  30.     $ torneira
    31. 

  31. 

  32. In the directory `demos/simple_app/` there is a minimal app already configured.
    33. 

  33. If you want to see a more complex app that uses more available features, take a
    34. 

  34. look at `demos/more_complex_app`.
    35. 

  35. 

  36. To see all options that `torneira` command support, run:
    37. 

  37. 

  38.     $ torneira --help
    39. 

  39. 

  40. Contributing
    41. 

  41. ------------
    42. 

  42. 

  43. Send a pull request (preferred) or patches using ``git format-patch``. Also,
    44. 

  44. torneira comes with some tests in `tests/` directory. Make sure you don't break
    45. 

  45. anything accidentally and also write some tests for your fix/feature.
    46. 

  46. 

  47. Issues
    48. 

  48. ------
    49. 

  49. 

  50. Please report any issues on `GitHub issues`_.
    51. 

  51. 

  52. Dependencies
    53. 

  53. ------------
    54. 

  54. 

  55.  * Tornado_ (tested with 2.3 and 2.4)
    56. 

  56. 

  57. Optional dependencies:
    58. 

  58. 

  59.  * Mako_ (if you want to use Mako templates instead of built-in tornado.template)
    60. 

  60.  * `SQL Alchemy`_ (only if using torneira.models)
    61. 

  61. 

  62. On Python 2.5 we also need simplejson_ module.
    63. 

  63. 

  64. .. _GitHub issues: https://github.com/marcelnicolay/torneira/issues
    65. 

  65. .. _Mako: http://www.makotemplates.org/
    66. 

  66. .. _PyPI: http://pypi.python.org/package/torneira/
    67. 

  67. .. _SQL Alchemy: http://www.sqlalchemy.org/
    68. 

  68. .. _simplejson: http://code.google.com/p/simplejson/
    69. 

  69. .. _Tornado: http://www.tornadoweb.org/
    70. 

  70.