Saravanan666/pypi-org huggingface dataset:
Package: wishbone-flow-jsonvalidate
__       __    __
.--.--.--|__.-----|  |--|  |--.-----.-----.-----.
|  |  |  |  |__ --|     |  _  |  _  |     |  -__|
|________|__|_____|__|__|_____|_____|__|__|_____|
                                   version 2.1.2

Build composable event pipeline servers with minimal effort.


==========================
wishbone.flow.jsonvalidate
==========================

Version: 1.0.0

Validates JSON data against JSON-schema.
----------------------------------------


    Validates the a Python dictionary (converted from a JSON string) against a
    predefined JSONschema. http://json-schema.org/

    The defined schema has to be valid JSON data.

    Events which do not pass validation are send to the default <failed> queue.

    Parameters:

        - schema(str)(None)
           |  The filename of the JSON validation schema to load.  When no
           |  schema is defined no validation is done.


    Queues:

        - inbox
           |  Incoming messages

        - outbox
           |  Outgoing messges
Package: wishbone_function_template
__       __    __
.--.--.--|__.-----|  |--|  |--.-----.-----.-----.
|  |  |  |  |__ --|     |  _  |  _  |     |  -__|
|________|__|_____|__|__|_____|_____|__|__|_____|
                                   version 2.1.2

Build composable event pipeline servers with minimal effort.


==========================
wishbone.function.template
==========================

Version: 1.0.0

A Wishbone module which generates a text from a dictionary and a template.
--------------------------------------------------------------------------


    Converts a dictionary to a text using the defined Jinja2 template.

    Optionally header template values can be converted too.


    Parameters:

        - location(str)("./")
           |  The directory containing templates.

        - template(str)()*
           |  The template filename stored in directory <location>.

        - source(str)("@data")*
           |  The dictionary to use.

        - destination(str)("@data")*
           |  The location to which the rendered result has to be stored.

        - header_templates(dict)({})*
           |  A dict of templates to render. Can be lookup values.
           |  Results are stored in this module's instance header
           |  using the provided key.



    Queues:

        - inbox
           |  Incoming events

        - outbox
           |  Outgoing events
Package: wishbone_function_twitterbookmark
__       __    __
.--.--.--|__.-----|  |--|  |--.-----.-----.-----.
|  |  |  |  |__ --|     |  _  |  _  |     |  -__|
|________|__|_____|__|__|_____|_____|__|__|_____|
                                   version 2.2.0

Build composable event pipeline servers with minimal effort.



=================================
wishbone.function.twitterbookmark
=================================

Version: 1.0.0

Creates URL bookmarks from Twitter favorite events
--------------------------------------------------


    The module takes a Twitter favorite event and extracts the URLs, tags and
    keywords.

    Bookmark event:

    @tmp.<name>.type            Can be either "text" or "bookmark"
    @tmp.<name>.url             The extracted URL. (1 event per URL)
    @tmp.<name>.summary         An array of the meaningfull words of the tweet.
                                uninteresting words.
    @tmp.<name>.tags            An array of tags
    @tmp.<name>.screen_name     The name of the tweet author.
    @tmp.<name>.created_at      The timestamp of the tweet.


    Parameters:

        - blacklist(array)([])
           |  A list of keywords to drop from the tweet to form the summary.


    Queues:

        - inbox
           |  Incoming events

        - outbox
           |  Outgoing events
Package: wishbone_input_disk
__       __    __
.--.--.--|__.-----|  |--|  |--.-----.-----.-----.
|  |  |  |  |__ --|     |  _  |  _  |     |  -__|
|________|__|_____|__|__|_____|_____|__|__|_____|
                                   version 2.1.2

Build composable event pipeline servers with minimal effort.


===================
wishbone.input.disk
===================

Version: 1.0.0

Reads messages from a disk buffer.
----------------------------------



    Parameters:

        - directory(str)
           |  The directory to write data to.

        - idle_trigger(bool)(False)
           |  When True, only reads events when no new events
           |  have been written to disk for at least <idle_time>.


        - idle_time(int)(10)
           |  The time in seconds required that no new events
           |  have been written to disk prior to start to consume
           |  the buffered data.


    Queues:

        - outbox
           |  Incoming events.
Package: wishbone_input_gearman
__       __    __
.--.--.--|__.-----|  |--|  |--.-----.-----.-----.
|  |  |  |  |__ --|     |  _  |  _  |     |  -__|
|________|__|_____|__|__|_____|_____|__|__|_____|
                                   version 2.1.2

Build composable event pipeline servers with minimal effort.


======================
wishbone.input.gearman
======================

Version: 1.0.0

Consumes events/jobs from  Gearmand.
------------------------------------


    Consumes jobs from a Gearmand server.
    When secret is none, no decryption is done.


    Parameters:

        - hostlist(list)(["localhost:4730"])
           |  A list of gearmand servers.  Each entry should have
           |  format host:port.

        - secret(str)(None)
           |  The AES encryption key to decrypt Mod_gearman messages.

        - workers(int)(1)
           |  The number of gearman workers within 1 process.

        - queue(str)(wishbone)
           |  The queue to consume jobs from.


    Queues:

        - outbox:   Outgoing events.
Package: wishbone_input_httpclient
__       __    __
.--.--.--|__.-----|  |--|  |--.-----.-----.-----.
|  |  |  |  |__ --|     |  _  |  _  |     |  -__|
|________|__|_____|__|__|_____|_____|__|__|_____|
                                   version 2.1.2

Build composable event pipeline servers with minimal effort.


=========================
wishbone.input.httpclient
=========================

Version: 1.0.0

A HTTP client doing http requests to pull data in.
--------------------------------------------------


    This module requests an URL at the defined interval.


    Parameters:

        - url(str/list)("http://localhost")
           |  The URL to fetch (including port).
           |  When a list, will process all urls defined.

        - username(str)(None)
           |  The login to use.

        - password(str)(None)
           |  The password to use.

        - interval(int)(60)
           |  The interval in seconds between each request.

        - allow_redirects(bool)(False)
           |  Allow redirects.

        - timeout(float)(10)
           |  The maximum amount of time in seconds the request is allowed to take.


   Queues:

        - outbox
           |  Incoming events


    The header contains:

        - status_code:          The status code of the request.
Package: wishbone_input_irc
__       __    __
.--.--.--|__.-----|  |--|  |--.-----.-----.-----.
|  |  |  |  |__ --|     |  _  |  _  |     |  -__|
|________|__|_____|__|__|_____|_____|__|__|_____|
                                   version 2.1.2

Build composable event pipeline servers with minimal effort.


==================
wishbone.input.irc
==================

Version: 1.0.0

Joins an IRC channel to accept input.
-------------------------------------


    A simple IRC bot which joins a channel, reads all public and private
    messages and sends these to the module's queues.


    Parameters:

        - server(str)("localhost")
           |  The IRC server to connect to.

        - port(int)(6667)
           |  The IRC server port to connect to.

        - nickname(str)("wishbone")
           |  The bot's nickname.

        - channels(list)(["wishbone"])
           |  The list of channels to join.
           |  Each channel is mapped to a queue.
           |  The queue name has the # portion stripped off.

        - password(str)(None)
           |  The password used to authenticate

    Queues:

        - outbox
           |  The messages of all channels.

        - priv__<nickname>
           |  Receives private messages.

        - <channels>

           |  For each channel in <channels> a queue is created receiving the
           |  messages of only that channel.
Package: wishbone_input_livestatus
__       __    __
.--.--.--|__.-----|  |--|  |--.-----.-----.-----.
|  |  |  |  |__ --|     |  _  |  _  |     |  -__|
|________|__|_____|__|__|_____|_____|__|__|_____|
                                   version 2.1.2

Build composable event pipeline servers with minimal effort.


=========================
wishbone.input.livestatus
=========================

Version: 1.0.0

Queries Livestatus at the chosen interval.
------------------------------------------


    Queries LiveStatus with the predefined query and returns each returned
    record as new event


    Parameters:

        - host(str)("127.0.0.1")
           |  The Livestatus address/hostname to connect to.

        - port(int)(6557)
           |  Explaining the parameter.

        - timeout(int)(10)
           |  Timeout in seconds to connect.

        - query(str)("GET Status")
           |  The query to execute

        - interval(int)(10)
           |  The interval to query

    Queues:

        - outbox
           |  A description of the queue
Package: wishbone_input_tcp
__       __    __
.--.--.--|__.-----|  |--|  |--.-----.-----.-----.
|  |  |  |  |__ --|     |  _  |  _  |     |  -__|
|________|__|_____|__|__|_____|_____|__|__|_____|
                                   version 2.1.2

Build composable event pipeline servers with minimal effort.


==================
wishbone.input.tcp
==================

Version: 1.0.0

Receive data over a TCP socket.
-------------------------------


    Receive data over a TCP socket.


    Parameters:

        - address(str)("0.0.0.0")
           |  The address to bind to.

        - port(int)(19283)
           |  The port to bind to.

        - delimiter(str)("\n")
           |  The delimiter which separates multiple
           |  messages in a stream of data.

        - max_connections(int)(0)
           |  The maximum number of simultaneous
           |  connections.  0 means "unlimited".

        - reuse_port(bool)(False)
           |  Whether or not to set the SO_REUSEPORT
           |  socket option.  Interesting when starting
           |  multiple instances and allow them to bind
           |  to the same port.
           |  Requires Linux kernel >= 3.9

    Queues:

        - outbox
           |  Data coming from the outside world.


    **delimiter**

    When no delimiter is defined, all incoming data between connect and
    disconnect is considered to be 1 event. When a delimiter is defined,
    multiple events are extracted out of a data stream using the defined
    delimiter.  The module will check each line of data whether it ends with
    the delimiter.  If not the line will be added to an internal buffer.  If
    so, the delimiter will be stripped of and when there is data left, it will
    be added to the buffer after which the buffer will be flushed as one
    Wishbone message/event.  The advantage is that a client can stay connected
    and stream data.

    Choosing "\n" as a delimiter, which is the default, each new line is a new event.
Package: wishbone_input_twitter
__       __    __
.--.--.--|__.-----|  |--|  |--.-----.-----.-----.
|  |  |  |  |__ --|     |  _  |  _  |     |  -__|
|________|__|_____|__|__|_____|_____|__|__|_____|
                                   version 2.2.0

Build composable event pipeline servers with minimal effort.



======================
wishbone.input.twitter
======================

Version: 1.0.0

Reads Tweets from Twitter.
--------------------------


    Reads tweets from Twitter.


    Parameters:

        - consumer_key(str)()
           |  The Twitter consumer_key value to authenticate.

        - consumer_secret(str)()
            | The Twitter consumer_secret value to authenticate.

        - access_token(str)()
            | The Twitter access_token value to authenticate.

        - access_token_secret(str)()
            | The Twitter access_token_secret value to authenticate.

        - timeline(bool)(False)
            | If True includes all events of the authenticated user's timeline

        - users(list)[]
            | A list of users to follow

        - track(list)["#wishbone"]
            | A list of expressions to follow

    Queues:

        - outbox
           |  Incoming Tweets
Package: wishbone_input_udp
__       __    __
.--.--.--|__.-----|  |--|  |--.-----.-----.-----.
|  |  |  |  |__ --|     |  _  |  _  |     |  -__|
|________|__|_____|__|__|_____|_____|__|__|_____|
                                   version 2.1.2

Build composable event pipeline servers with minimal effort.


==================
wishbone.input.udp
==================

Version: 1.0.0

Receive data over an UDP socket.
--------------------------------


    A UDP server.

    Parameters:

        - address(string)("0.0.0.0")
           |  The address to bind to.

        - port(int)(19283)
           |  The port to listen on.

        - reuse_port(bool)(False)
           |  Whether or not to set the SO_REUSEPORT socket option.
           |  Allows multiple instances to bind to the same port.
           |  Requires Linux kernel >= 3.9

    Queues:

        - outbox
           |  Incoming events.
Package: wishbone_input_zmqpull
__       __    __
.--.--.--|__.-----|  |--|  |--.-----.-----.-----.
|  |  |  |  |__ --|     |  _  |  _  |     |  -__|
|________|__|_____|__|__|_____|_____|__|__|_____|
                                   version 2.1.2

Build composable event pipeline servers with minimal effort.


======================
wishbone.input.zmqpull
======================

Version: 1.0.0

Pulls events from one or more ZeroMQ push modules.
--------------------------------------------------


    Expects to connect with one or more wishbone.input.push modules.  This
    module can be started in client or server mode.  In server mode, it waits
    for incoming connections.  In client mode it connects to the defined
    servers.  Events are spread in a round robin pattern over all connections.

    Parameters:

        - mode(str)("server")
           |  The mode to run in.  Possible options are:
           |  - server: Binds to a port and listens.
           |  - client: Connects to a port.

        - interface(string)("0.0.0.0")
           |  The interface to bind to in server <mode>.

        - port(int)(19283)
           |  The port to bind to in server <mode>.

        - servers(list)([])
           |  A list of hostname:port entries to connect to.
           |  Only valid when running in "client" <mode>.


    Queues:

        - outbox
           |  Events arriving from the outside.
Package: wishbone_input_zmqtopic
__       __    __
.--.--.--|__.-----|  |--|  |--.-----.-----.-----.
|  |  |  |  |__ --|     |  _  |  _  |     |  -__|
|________|__|_____|__|__|_____|_____|__|__|_____|
                                   version 2.1.2

Build composable event pipeline servers with minimal effort.


=======================
wishbone.input.zmqtopic
=======================

Version: 1.0.0

Subscribes to one or more ZeroMQ Topic publish modules.
-------------------------------------------------------


    Consumes data from one or more ZeroMQ publishers.

    Parameters:

        - host(string)("localhost")
           |  The host to submit to.

        - port(int)(19283)
           |  The port to submit to.

        - timeout(int)(1)
           |  The time in seconds to timeout when connecting

        - topic(string)("")
           |  The topic to subscribe to.


    Queues:

        - outbox
           |  Incoming events.
Package: wishbone_output_disk
__       __    __
.--.--.--|__.-----|  |--|  |--.-----.-----.-----.
|  |  |  |  |__ --|     |  _  |  _  |     |  -__|
|________|__|_____|__|__|_____|_____|__|__|_____|
                                   version 2.1.2

Build composable event pipeline servers with minimal effort.


====================
wishbone.output.disk
====================

Version: 1.0.0

Writes complete messages to a disk buffer.
------------------------------------------


    Persists complete incoming messages to disk.

        Parameters:

        - selection(str)("@data")
           |  The part of the event to submit externally.
           |  Use an empty string to refer to the complete event.

        - directory(str)("./)
           |  The directory to write data to.

        - interval(int)(10)
           |  The time in seconds to flush the queue to disk.


    Queues:

        - inbox
           |  Incoming events.
Package: wishbone_output_elasticsearch
__       __    __
.--.--.--|__.-----|  |--|  |--.-----.-----.-----.
|  |  |  |  |__ --|     |  _  |  _  |     |  -__|
|________|__|_____|__|__|_____|_____|__|__|_____|
                                   version 2.1.2

Build composable event pipeline servers with minimal effort.


=============================
wishbone.output.elasticsearch
=============================

Version: 1.0.0

Submit data to Elasticsearch.
-----------------------------


    Submits data to Elasticsearch.

    Events are indexed one by one.

    Events can be indexed in bulk to increase throughput when incoming events
    are type <Bulk>.  Bulk objects consist out of multiple events and are
    created by the <wishbone.flow.tippingbucket> module.

    Parameters:

        - selection(str)("@data")
           |  The part of the event to submit externally.
           |  Use an empty string to refer to the complete event.

        - hosts(list)(["localhost:9200"])
           |  A list of "hostname:port" strings.

        - use_ssl(bool)(False)
           |  When enable expects SSL connectivity

        - verify_certs(bool)(False)
           |  When using SSL do certificate verification

        - index(str)("wishbone")
           |  The name of the index

        - doc_type(str)("wishbone")
           |  The document type

    Queues:

        - inbox
           |  Incoming events submitted to the outside.
Package: wishbone_output_email
__       __    __
.--.--.--|__.-----|  |--|  |--.-----.-----.-----.
|  |  |  |  |__ --|     |  _  |  _  |     |  -__|
|________|__|_____|__|__|_____|_____|__|__|_____|
                                   version 2.1.2

Build composable event pipeline servers with minimal effort.


=====================
wishbone.output.email
=====================

Version: 1.0.0

Sends out incoming events as email.
-----------------------------------


    Treats event.data as the body of an email.


    Parameters:

        - selection(str)("@data")
           |  The part of the event to submit externally.
           |  Use an empty string to refer to the complete event.

        - mta(string)("localhost:25)
           |  The address:port of the MTA to submit the
           |  mail to.

        - to(list)([])*
           |  A list of destinations.

        - subject(str)("Wishbone")*
           |  The subject of the email.

        - from_address(str)("wishbone@localhost")*
           |  The form email address.


    Queues:

        - inbox
           |  Incoming messages
Package: wishbone_output_file
::__       __    __.--.--.--|__.-----|  |--|  |--.-----.-----.-----.|  |  |  |  |__ --|     |  _  |  _  |     |  -__||________|__|_____|__|__|_____|_____|__|__|_____|===================================wishbone_contrib.module.output.file===================================Version: 3.0.0Writes events to a file.------------------------Writes events to a file.Parameters::- directory(str)("./")|  The directory to write the files to.- filename(str)("wishbone.out")*|  The filename to use.- native_events(bool)(False)|  Submit Wishbone native events.- overwrite(bool)(False)|  If `True` overwrites each time the content otherwise appends to|  the end of the file.- parallel_streams(int)(1)|  The number of outgoing parallel data streams.- payload(str)(None)|  The string to submit.|  If defined takes precedence over `selection`.- selection(str)("data")*|  The part of the event to submit externally.|  Use an empty string to refer to the complete event.Queues::- inbox|  Incoming messages
Package: wishbone_output_http
__       __    __
.--.--.--|__.-----|  |--|  |--.-----.-----.-----.
|  |  |  |  |__ --|     |  _  |  _  |     |  -__|
|________|__|_____|__|__|_____|_____|__|__|_____|


===================================
wishbone_contrib.module.output.http
===================================

Version: 3.0.2

Submit data to a http API.
--------------------------
**Submit data to a http API.**

    Submit data to a http API.


    Parameters::

        - accept(str)("text/plain")*
           |  The accept value to use.

        - additional_headers(dict)({})
           |  A dictionary of additional headers.

        - allow_redirects(bool)(False)*
           |  Allow redirects.

        - content_type(str)("application/json")*
           |  The content type to use.

        - method(str)("PUT")
           |  The http method to use. PUT/POST

        - native_events(bool)(False)
           |  Submit Wishbone native events.

        - parallel_streams(int)(1)
           |  The number of outgoing parallel data streams.

        - password(str)*
           |  The password to authenticate

        - pool_size(int)(1)
           |  The outgoing pool size.

        - selection(str)("data")*
           |  The part of the event to submit externally.
           |  Use an empty string to refer to the complete event.

        - url(str)("http://localhost:19283")*
           |  The url to submit the data to

        - username(str)*
           |  The username to authenticate

        - timeout(float)(10)*
           |  The maximum amount of time in seconds the request is allowed to take.

        - verify_ssl(bool)(True)
           |  Validate the SSL certificate


    Queues::

        - inbox
           |  Incoming messages
Package: wishbone_output_sse
__       __    __
.--.--.--|__.-----|  |--|  |--.-----.-----.-----.
|  |  |  |  |__ --|     |  _  |  _  |     |  -__|
|________|__|_____|__|__|_____|_____|__|__|_____|
                                   version 2.1.2

Build composable event pipeline servers with minimal effort.


===================
wishbone.output.sse
===================

Version: 1.0.0

Serve event data as server sent events.
---------------------------------------


    Serve event data as server sent events.

    When the event header contains:

    If nobody is consuming events then they're lost.
    If <show_last> is set to True, then the last known value
    can be consumed by the client.

    Parameters:

        - selection(str)("@data")
           |  The part of the event to submit externally.
           |  Use an empty string to refer to the complete event.

        - bind(string)("0.0.0.0")
           |  The address to bind to.

        - port(int)(19283)
           |  The port to bind to.

        - show_last(bool)(False)
           |  If true submits the last known value to
           |  a new connection.

        - keepalive(bool)(False)
           |  If true sends a keepalive message at
           |  <keepalive_interval> seconds.

        - keepalive_interval(int)(False)
           |  The time in seconds to send keep-alive
           |  messages to the client.

        - destination(str)("")*
           |  The endpoint from which the event can be consumed.


    Queues:

        - inbox
           |  Incoming events submitted to the outside.