Ksconf

~~~~~~~~~~~~~~~~~~~~~~~~~~~

- Add readthedocs.io support

~~~~~~~~~~~~~~~~~~~~~~~~~~~

- Enable PyPI production package building

~~~~~~~~~~~~~~~~~~~~~~~~~~~

- Refactor entire code base. Switched from monolithic all-in-one file to clean-cut modules.
- Versioning is now discoverable via ``ksconf --version``, and controlled via git tags (via
``git describe --tags``).

Module layout
^^^^^^^^^^^^^

- ``ksconf.conf.*`` - Configuration file parsing, writing, comparing, and so on
- ``ksconf.util.*`` - Various helper functions
- ``ksconf.archive`` - Support for decompressing Splunk apps (tgz/zip files)
- ``ksconf.vc.git`` - Version control support. Git is the only VC tool supported for now. (Possibly ever)
- ``ksconf.commands.<CMD>`` - Modules for specific CLI functions. I may make this extendable, eventually.

Ksconf 0.3.x
------------

First public releases.

~~~~~~~~~~~~~~~~~~~~~~~~~~~

- Add AppVeyor for Windows platform testing
- Add codecov integration
- Created ConfFileProxy.dump()

~~~~~~~~~~~~~~~~~~~~~~~~~~~

- Setup automation via Travis CI
- Add code coverage

~~~~~~~~~~~~~~~~~~~~~~~~~~~

- Switched to semantic versioning.
- 0.3.0 feels representative of the code maturity.

Ksconf legacy releases
----------------------

Ksconf started in a private Kintyre repo. There are no official releases; all git history has been
rewritten.

Release legacy-v1.0.1 (2018-04-20)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

- Fixes to blocklist support and many enhancements to ``ksconf unarchive``.
- Introduces parsing profiles.
- Lots of bug fixes to various subcommands.
- Added automatic detection of ‘subcommands’ for CLI documentation helper script.

Release legacy-v1.0.0 (2018-04-16)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

- This is the first public release. First work began Nov 2017 (as a simple conf ‘sort’ tool,
which was imported from yet another repo.) Version history was extracted/rewritten/preserved
as much as possible.
- Mostly stable features.
- Unit test coverage over 85%
- Includes pre-commit hook configuration (so that other repos can use this to run ``ksconf sort``
and ``ksconf check`` against their conf files.


.. include:: common