===
API
===

You can use runchain from your Python code

.. code-block:: python

    from runchain import Chain, list_chains

    # List all chains
    chains = list_chains()
    print("Available chains:", chains)

    # Work with a specific chain
    backup_chain = Chain("backup")
    
    if backup_chain.exists():
        print("Scripts in backup chain:", backup_chain.list())
    
    # Add a script file
    backup_chain.add_file("~/scripts/database.sh", "10")
    backup_chain.add_file("~/scripts/files.py", "20-backup-files")
    
    # Add a script from string content
    backup_chain.add_string(
        "#!/bin/bash",
        "echo 'Hello from string script'",
        target="30-hello"
    )
    
    # Schedule the chain
    backup_chain.cron("0 2 * * *")
    
    # Run the chain
    success = backup_chain.run()
    if success:
        print("Backup completed successfully")
    
    # Remove a script
    backup_chain.remove("10-database.sh")
    
    # Remove entire chain
    backup_chain.destroy()


API reference
=============

.. autoclass:: runchain.chain.Chain
	:members:
	:show-inheritance:

.. autofunction:: runchain.chain.list_chains