Scriv

-------------------

Added
.....

- Support finding version information in TOML files (like ``pyproject.toml``)
using the ``literal`` configuration directive. Thanks, Kurt McKee

-------------------

Added
.....

- Fragment files in the fragment directory will be skipped if they match the
new configuration value ``skip_fragments``, a glob pattern. The default
value is "README.*". This lets you put a README.md file in that directory to
explain its purpose, as requested in `issue 40`_.

.. _issue 40: https://github.com/nedbat/scriv/issues/40

Changed
.......

- Switched from "toml" to "tomli" for reading TOML files.

Fixed
.....

- Setting ``format=md`` didn't properly cascade into other default settings,
leaving you with RST settings that needed to be explicitly overridden
(`issue 39`_). This is now fixed.

.. _issue 39: https://github.com/nedbat/scriv/issues/39

-------------------

Added
.....

- A new poorly documented API is available. See the Scriv, Changelog, and
Fragment classes in the scriv.scriv module.

Changed
.......

- Python 3.6 is now the minimum supported Python version.

Fixed
.....

- The changelog is now always written as UTF-8, regardless of the default
encoding of the system. Thanks, Hei (yhlam).

-------------------

Added
.....

- Settings can now be read from a pyproject.toml file. Install with the
"[toml]" extra to be sure TOML support is available. Closes `issue 9`_.

.. _issue 9: https://github.com/nedbat/scriv/issues/9

- Added the Philosophy section of the docs.

Changed
.......

- The default entry header no longer puts the version number in square
brackets: this was a misunderstanding of the keepachangelog formatting.

- Respect the existing newline style of changelog files. (`14`_)
This means that a changelog file with Linux newlines on a Windows platform
will be updated with Linux newlines, not rewritten with Windows newlines.
Thanks, Kurt McKee.

.. _14: https://github.com/nedbat/scriv/issues/14

Fixed
.....

- Support Windows' directory separator (``\``) in unit test output. (`15`_)
This allows the unit tests to run in Windows environments. Thanks, Kurt
McKee.

- Explicitly specify the directories and files that Black should scan. (`16`_)
This prevents Black from scanning every file in a virtual environment.
Thanks, Kurt McKee.

- Using "literal:" values in the configuration file didn't work on Python 3.6
or 3.7, as reported in `issue 18`_. This is now fixed.

.. _15: https://github.com/nedbat/scriv/issues/15
.. _16: https://github.com/nedbat/scriv/issues/16
.. _issue 18: https://github.com/nedbat/scriv/issues/18

------------------

- Packaging fix.

------------------

Added
.....

- Markdown format is supported, both for fragments and changelog entries.

- Fragments can be mixed (some .rst and some .md). They will be collected and
output in the format configured in the settings.

- Documentation.

- "python -m scriv" now works.

Changed
.......

- The version number is displayed in the help message.