Carnifex
===============================================================================

Carnifex provides an api for executing commands.
The processes can be started locally or remotely on another machine with
minimal effort for the user.

Carnifex builds on Twisted and uses Twisted Conch for executing commands
on a remote machine.


License
*******************************************************************************

Carnifex is made available under the MIT license. See the included LICENSE file
for details.


Changes
*******************************************************************************
Version 0.2.4
-------------------------------------------------------------------------------
- Replace code that used pwd module with cross-platform alternative

Version 0.2.3
-------------------------------------------------------------------------------
- Fix pty support for SSH

Version 0.2.2
-------------------------------------------------------------------------------
- Fix missing packages in distribution
- License and documentation updates
- Example scripts
- Fixed issue with reconnecting after immediate failure in SSH inductor

Version 0.2.1
-------------------------------------------------------------------------------
- More flexible connection support for ssh inductor (e.g. IPv6)
- API for connecting Protocol to various SSH sessions ('shell', 'exec'
  and 'subsystem')
- Bug fixes

Version 0.2.0
-------------------------------------------------------------------------------
- Added support for authenticating with stored credentials when using
  remote process inductor
- Added support for specifying valid known hosts to allow with remote execution
- API change: execute, run, getOutput and getExitCode now take a command object
  or a string for the command to execute instead of executable and args.

Version 0.1.0
-------------------------------------------------------------------------------
- Executing and running processes locally and remotely via ssh is supported.
- Initial alpha release
