Skip to main content

A framework for easy automation of Bitcoin related tasks. PipeCash is flexible due to it's plugin system and configuration options. Read more at

Project description


.. image::

.. image::

.. image::
:alt: Documentation Status

.. image::
:alt: Updates

* Documentation:
* Website:

A framework for easy automation of Bitcoin related tasks. PipeCash is flexible due to it's plugin system and configuration options. Read more at


PipeCash is a framework for automation of Bitcoin Related tasks.

It reads a configuration (json file) and executes the appropriate tasks (called "agents") at the appropriate times, in a way similar to IFTTT.

An agent may be scheduled (to run at specific times), controlled (to run when another agent tells it to), receive event data (when another agent produces an event), or just be started once and run in the background.

Agents represent simple actions:

* Sending an email
* Reading a file
* Getting specific data from the internet
* etc...

An agent can have access to a wallet and use the standard wallet interface to perform a money related task.
Such an agent should work the same, even if it uses a different wallet, or even a different currency.

This package contains the core functionality of PipeCash, needed to run any PipeCash instance.

The package does not contain any PipeCash agents or wallets. They must come from separate packages.

It does not contain any configurations either.
At this stage users will be required to create their own configurations.

Quick Start

Run a scenario:

.. code-block:: bash

pipecash -s /path/to/scenario.json

If the scenario needs secret variables, generate them:

.. code-block:: bash

pipecash -s /path/to/scenario.json --createSecretsFile > secrets.json

Once the file is generated, open it and fill the secret variables.
To run the scenario together with the secrets, use:

.. code-block:: bash

pipecash -s /path/to/scenario.json --secretsPath /path/to/secrets.json

To tell us about a bug, please see the issue template :

======= (2019-02-08)

* major bug fixes (2019-02-08)

* Changed OptionTemplateSolver:
* Templates resolve to actual objects, instead of their string representation
* Templates can no longer be combined with a string outside the template.
* Example Template: '{{'one two'.split()}}' resolves to ['one', 'two'] (array)
* Example Invalid Template: 'The answer is {{40+2}}!' does not resolve and remains the same string. (2019-02-08)

* New Feature: GetNeededSecrets
* minor bug fixes (2019-02-08)

* First release on PyPI.

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for pipecash, version
Filename, size File type Python version Upload date Hashes
Filename, size pipecash- (37.4 kB) File type Source Python version None Upload date Hashes View
Filename, size pipecash- (17.9 kB) File type Wheel Python version py2.py3 Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page