Composing and compiling the epics of conquest, self-reflection and defeat in your software projects. Singing them is better left as an exercise for the reader.
For general use purposes:
pip3 install git+https://github.com/jonathanj/cacofonix.gitFor development purposes:
# Clone the repo.
git clone git@github.com:jonathanj/cacofonix.git
cd cacofonix
# Install the package with -e to use a "source" install, this runs the
# package from source instead of installing it, avoiding the need to
# continually install it when developing.
pip3 install -e .After installing the package, a command-line script will installed that can be
run as cacofonix. If the script cannot be found then it is likely not on
your shell search path.
See config.example.yaml for a commented example configuration.
Cacofonix has two modes of operation:
- Compose new change fragments, to store in the repo until a later time.
- Compile a changelog from the existing change fragments, and merge these with an existing changelog.
In both of these modes the --config option (required) must be specified
before the subcommand:
cacofonix --config path/to/config.yaml compose …The basic usage is to use cacofonix compose to do the following:
- Compose a new change fragment;
- Write it to the change fragment directory, as specified in the configuration;
- Stage the file in git.
Consult cacofonix compose --help for detailed command-line help.
The basic usage is to use cacofonix compile to do the following:
- Find uncompiled change fragments;
- Convert each fragment to suitable markup;
- Compile them together to create a new changelog, for one version;
- Merge the new changelog into an existing changelog;
- Clean up and stage the removals in git.
Consult cacofonix compile --help for detailed command-line help.
Thanks to Amber Brown for towncrier, upon which Cacofonix is built, (using private APIs, sorry!)