PageRenderTime 58ms CodeModel.GetById 34ms RepoModel.GetById 1ms app.codeStats 0ms

/README.rst

https://github.com/foundit/Piped
ReStructuredText | 48 lines | 31 code | 17 blank | 0 comment | 0 complexity | 24b3ecc83dd9c0197ae35835f284ab77 MD5 | raw file
    

  1. Piped: a framework and application server with pipelines
    2. 

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

  3. 

  4. Piped is an `MIT-licensed <https://github.com/foundit/Piped/blob/develop/LICENSE>`_ framework and
    5. 

  5. application server with built-in support for
    6. 

  6. `flow based programming <http://en.wikipedia.org/wiki/Flow-based_programming>`_ written in Python that focuses on:
    7. 

  7. 

  8. * Extendability.
    9. 

  9. * Painless integrating with other systems.
    10. 

  10. * Testing and maintainability.
    11. 

  11. * Performance.
    12. 

  12. * Ease of use.
    13. 

  13. 

  14. Being based on `Twisted http://twistedmatrix.com/`, a base Piped installation already speaks multiple protocols, such as HTTP, SMTP and Perspective Broker. Contrib packages that extend Piped are also available.
    15. 

  15. 

  16. 

  17. Documentation
    18. 

  18. -------------
    19. 

  19. 

  20. The documentation is available at http://piped.io.
    21. 

  21. 

  22. 

  23. Protocols and Extensions
    24. 

  24. ------------------------
    25. 

  25. 

  26. * HTTP/HTTPS with `twisted.web <http://twistedmatrix.com/trac/wiki/TwistedWeb>`_ or `Cyclone <http://cyclone.io>`_ (based on `Tornado <http://tornadoweb.org>`).
    27. 

  27. * SMTP with `twisted.mail <http://twistedmatrix.com/trac/wiki/TwistedMail>`_
    28. 

  28. * SSH with `twisted.conch <http://twistedmatrix.com/trac/wiki/TwistedConch>`_
    29. 

  29. * `ZeroMQ <http://www.zeromq.org/>`_ and `AMQP <http://www.amqp.org/>`_ (i.e `RabbitMQ <http://www.rabbitmq.com/>`_)
    30. 

  30. * `ZooKeeper <http://zookeeper.apache.org/>`_
    31. 

  31. * Database-connectivity (with `SQLAlchemy <http://sqlalchemy.org>`_)
    32. 

  32. * Data-validation (with `FormEncode <http://www.formencode.org/>`_)
    33. 

  33. 

  34. 

  35. Installing and testing
    36. 

  36. ----------------------
    37. 

  37. 

  38. See the installation instructions at http://www.piped.io/installing/
    39. 

  39. 

  40. 

  41. Contributing
    42. 

  42. ------------
    43. 

  43. 

  44. Report issues in the `issue tracker <https://github.com/foundit/Piped/issues>`_.
    45. 

  45. 

  46. Mailing lists are available at piped@librelist.com. Just send an email to the list to subscribe.
    47. 

  47. 

  48. Or ask questions about Piped on IRC (#piped on `freenode <http://freenode.net/>`_).
    49. 

  49.