Piped documentation

Piped is an MIT-licensed framework and application server with built-in support for flow based programming written in Python that focuses on:

• Extendability.
• Painless integrating with other systems.
• Testing and maintainability.
• Performance.
• Ease of use.

A base Piped installation already speaks multiple protocols, such as HTTP, SMTP and Perspective Broker. Contrib packages that extends Piped, adding support for database connectivity, message queues such as ZeroMQ and more are also available.

Found IT is currently writing search related extensions to Piped, which will be released as open source soon.

Lets get started:

Taking the first steps

You can install official releases from PYPI or development versions from GitHub. Detailed installation instructions are available, but the short version is:

$ easy_install piped

The Getting started tutorial is a good introduction to many important aspects of Piped, and is a recommended read for anyone new to the project.

If you just want to have a peek at how hello world looks in Piped, here is a sample web server that uses a pipeline:

web:
    first_step:
        routing:
            __config__:
                processor: pipeline.hello

pipelines:
    hello:
        - write-web-response:
            fallback_content: Piped says hello.

Learning more

Piped comes with multiple tutorials that focuses on different parts of Piped. Each of the tutorials focuses on different parts of Piped and teaches how to accomplish a lot of common tasks in Piped.

If you liked the tutorials, take a look at the topic guides. Each topic guide is a good introduction to different parts of Piped.

Piped comes with many built-in

• Processors that processes batons in pipelines.
• Providers that makes different resources available to pipelines.

If the processors and providers listed above is insufficient, extending Piped by writing new processors and providers is easy.

Digging deeper

The reference documentation provides a detailed view into the classes and functions that makes your process flow.

Feedback and contact

Report bugs with Piped in the issue tracker: https://github.com/foundit/Piped/issues. Patches and contributions are always welcome.

Ask questions about Piped on IRC (#piped on freenode).

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