Package: scriv
Scriv changelog management toolOverviewScriv is a command-line tool for helping developers maintain useful changelogs.
It manages a directory of changelog fragments. It aggregates them into entries
in a CHANGELOG file.Getting StartedScriv writes changelog fragments into a directory called “changelog.d”.  Start
by creating this directory.  (By the way, like many aspects of scriv’s
operation, you can choose a different name for this directory.)To make a new changelog fragment, use thescriv createcommand.  It will
make a new file with a filename using the current date and time, your GitHub or
Git user name, and your branch name.  Changelog fragments should be committed
along with all the other changes on your branch.When it is time to release your project, thescriv collectcommand
aggregates all the fragments into a new entry in your changelog file.You can also choose to publish your changelog entries as GitHub releases with
thescrivgithub-releasecommand.  It parses the changelog file and
creates or updates GitHub releases to match.  It can be used even with
changelog files that were not created by scriv.DocumentationFull documentation is athttps://scriv.readthedocs.org.LicenseThe code in this repository is licensed under the Apache Software License 2.0
unless otherwise noted.Please seeLICENSE.txtfor details.How To ContributeContributions are very welcome.  Thanks to all the contributors so far:Ned BatchelderAbhilash RajAgustín PiqueresFlo KuepperJames GerityJavier SagredoKurt McKeeMatias GuijarroRodrigo Girão SerrãoRonny PfannschmidtChangelogUnreleasedSee the fragment files in thechangelog.d directory.1.5.1 — 2023-12-14FixedFixed the documentation build on ReadTheDocs. Fixesissue 118.1.5.0 — 2023-10-18AddedRST to Markdown conversion can now be stricter.  Using the--fail-if-warnoption on thescrivgithub-releasescommand will fail the command if your
RST conversion generates warnings, for example due to malformed link
references.Thescrivgithub-releasecommand now has a--check-linksoption to
check URLs.  Each is fetched, and if an error occurs, warnings will show the
URLs that didn’t succeed.FixedCommands no longer display full tracebacks for exceptions raised by scriv
code.1.4.0 — 2023-10-12AddedLiterals can be extracted from .cabal files.
ThanksJavier Sagredo.Use the git configscriv.user_nickfor the user nick part
of the fragment file. Thanks toRonny Pfannschmidt,
fixingissue 103.Settings can now be prefixed withcommand:to execute the rest of the
setting as a shell command.  The output of the command will be used as the
value of the setting.FixedIf there are no changelog fragments,scriv collectnow exits with status
code of 2, fixingissue 110.Changelogs with non-version headings now produce an understandable error
message fromscriv collect, thanks toJames Gerity, fixingissue 100.1.3.1 — 2023-04-16FixedThe Version class introduced in 1.3.0 broke thescrivgithub-releasecommand.  This is now fixed.1.3.0 — 2023-04-16Added.cfgfiles can now be read withliteral:settings, thanks toMatias
Guijarro.FixedIn compliance withPEP 440, comparing version numbers now ignores a
leading “v” character.  This makes scriv more flexible about how you present
version numbers in various places (code literals, changelog entries, git
tags, and so on).  Fixesissue 89.1.2.1 — 2023-02-18FixedScriv would fail trying to import tomllib on Python <3.11 if installed
without the[toml]extra.  This is now fixed, closingissue 80.Settings specified asfile:will now search in the changelog directory
and then the current directory for the file.  The only exception is if the
first component is.or.., then only the current directory is
considered.  Fixesissue 82.Python variables with type annotations can now be read withliteral:settings, fixingissue 85.Error messages for mis-formedliteral:configuration values are more
precise, as requested inissue 84.Error messages from settings validation are ScrivExceptions now, and report
configuration problems more clearly and earlier in some cases.1.2.0 — 2023-01-18Addedscrivgithub-releasenow has a--repo=option to specify which GitHub
repo to use when you have multiple remotes.ChangedImproved the error messages fromscrivgithub-releasewhen a GitHub repo
can’t be identified among the git remotes.1.1.0 — 2023-01-16AddedThescrivgithub-releasecommand has a new setting,ghrel_template.
This is a template to use when building the release text, to add text before
or after the Markdown extracted from the changelog.Thescrivgithub-releasecommand now has a--dry-runoption to show
what would happen, without posting to GitHub.ChangedFile names specified forfile:settings will be interpreted relative to
the current directory if they have path components.  If the file name has no
slashes or backslashes, then the old behavior remains: the file will be found
in the fragment directory, or as a built-in template.All exceptions raised by Scriv are now ScrivException.FixedParsing changelogs now take theinsert-markersetting into account. Only
content after the insert-marker line is parsed.More internal activities are logged, to help debug operations.1.0.0 — 2022-12-03AddedNow literal configuration settings can be read from YAML files. Closesissue 69.
Thanks,Florian Küpper.FixedFixed truncated help summaries by shortening them, closingissue 63.0.17.0 — 2022-09-18AddedThecollectcommand now has a--title=TEXToption to provide the
exact text to use as the title of the new changelog entry.  Finishesissue
48.ChangedThegithub_releasecommand now only considers the top-most entry in the
changelog.  You can use the--alloption to continue the old behavior of
making or updating GitHub releases for all of the entries.This change makes it easier for projects to start using scriv with an
existing populated changelog file.Closesissue 57.FixedIf there were no fragments to collect,scriv collectwould make a new empty
section in the changelog.  This was wrong, and is now fixed. Now the
changelog remains unchanged in this case.  Closesissue 55.Thegithub-releasecommand will now issue a warning for changelog entries
that have no version number. These can’t be made into releases, so they are
skipped.  (issue 56).scriv collectwill end with an error now if the version number would
duplicate a version number on an existing changelog entry. Fixesissue 26.0.16.0 — 2022-07-24AddedThegithub_releasecommand will use a GitHub personal access token stored
in the GITHUB_TOKEN environment variable, or from a .netrc file.FixedThe github_release command was usinggit tagsas a command when it should
have usedgit tag.Anchors in the changelog were being included in the previous sections when
creating GitHub releases.  This has been fixed, closingissue 53.0.15.2 — 2022-06-18FixedQuoted commands failed, so we couldn’t determine the GitHub remote.0.15.1 — 2022-06-18AddedAdded docs forscrivgithub-release.FixedCall pandoc properly on Windows for the github_release command.0.15.0 — 2022-04-24RemovedDropped support for Python 3.6.AddedThegithub-releasecommand parses the changelog and creates GitHub releases
from the entries.  Changed entries will update the corresponding release.Added a--versionoption.ChangedParsing of fragments now only attends to the top-level section headers, and
includes nested headers instead of splitting on all headers.0.14.0 — 2022-03-23AddedAdd an anchor before each version section in the output ofscriv collectso URLs for the sections are predictable and stable for each new version
(Fixesissue 46). Thanks Abhilash Raj and Rodrigo Girão Serrão.FixedMarkdown fragments weren’t combined properly. Now they are. Thanks Rodrigo
Girão Serrão.0.13.0 — 2022-01-23AddedSupport finding version information in TOML files (likepyproject.toml)
using theliteralconfiguration directive.  Thanks, Kurt McKee0.12.0 — 2021-07-28AddedFragment files in the fragment directory will be skipped if they match the
new configuration valueskip_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 inissue 40.ChangedSwitched from “toml” to “tomli” for reading TOML files.FixedSettingformat=mddidn’t properly cascade into other default settings,
leaving you with RST settings that needed to be explicitly overridden
(issue 39).  This is now fixed.0.11.0 — 2021-06-22AddedA new poorly documented API is available.  See the Scriv, Changelog, and
Fragment classes in the scriv.scriv module.ChangedPython 3.6 is now the minimum supported Python version.FixedThe changelog is now always written as UTF-8, regardless of the default
encoding of the system.  Thanks, Hei (yhlam).0.10.0 — 2020-12-27AddedSettings can now be read from a pyproject.toml file.  Install with the
“[toml]” extra to be sure TOML support is available.  Closesissue 9.Added the Philosophy section of the docs.ChangedThe 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.FixedSupport 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 inissue 18.  This is now fixed.0.9.2 — 2020-08-29Packaging fix.0.9.0 — 2020-08-29AddedMarkdown 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.ChangedThe version number is displayed in the help message.0.8.1 — 2020-08-09AddedWhen editing a new fragment during “scriv create”, if the edited fragment has
no content (only comments or blank lines), then the create operation will be
aborted, and the file will be removed. (Closesissue 2.)ChangedIf the fragment directory doesn’t exist, a simple direct message is shown,
rather than a misleading FileNotFound error (closesissue 1).FixedWhen not using categories, comments in fragment files would be copied to the
changelog file (issue 3).  This is now fixed.RST syntax is better understood, so that hyperlink references and directives
will be preserved. Previously, they were mistakenly interpreted as comments
and discarded.0.8.0 — 2020-08-04AddedAdded thecollectcommand.Configuration is now read from setup.cfg or tox.ini.A new configuration setting, rst_section_char, determines the character used
in the underlines for the section headings in .rst files.Thenew_entry_templateconfiguration setting is the name of the template
file to use when creating new entries.  The file will be found in thefragment_directorydirectory.  The file name defaults tonew_entry.FMT.j2.
If the file doesn’t exist, an internal default will be used.Now the collect command also includes a header for the entire entry.  The
underline is determined by the “rst_header_char” settings.  The heading text
is determined by the “header” setting, which defaults to the current date.The categories list in the config can be empty, meaning entries are not
categorized.The create command now accepts –edit (to open the new entry in your text
editor), and –add (to “git add” the new entry).The collect command now accepts –edit (to open the changelog file in an
editor after the new entries have been collected) and –add (to git-add the
changelog file and git rm the entries).The names of the main git branches are configurable as “main_branches” in the
configuration file.  The default is “master”, “main”, and “develop”.Configuration values can now be read from files by prefixing them with
“file:”.  File names will be interpreted relative to the changelog.d
directory, or will be found in a few files installed with scriv.Configuration values can interpolate the currently configured format (rst or
md) with “${config:format}”.The default value for new templates is now
“file: new_entry.${config:format}.j2”.Configuration values can be read from string literals in Python code with a
“literal:” prefix.“version” is now a configuration setting.  This will be most useful when used
with the “literal:” prefix.By default, the title of collected changelog entries includes the version if
it’s defined.The collect command now accepts a--versionoption to set the version
name used in the changelog entry title.ChangedRST now uses minuses instead of equals.Thecreatecommand now includes the time as well as the date in the entry
file name.The –delete option to collect is now called –keep, and defaults to False.
By default, the collected entry files are removed.Created file names now include the seconds from the current time.“scriv create” will refuse to overwrite an existing entry file.Made terminology more uniform: files in changelog.d are “fragments.”  When
collected together, they make one changelog “entry.”The title text for the collected changelog entry is now created from the
“entry_title_template” configuration setting.  It’s a Jinja2 template.Combined the rst_header_char and rst_section_char settings into one:
rst_header_chars, which much be exactly two characters.Parsing RST fragments is more flexible: the sections can use any valid RST
header characters for the underline.  Previously, it had to match the
configured RST header character.FixedFragments with no category header were being dropped if categories were in
use.  This is now fixed.  Uncategorized fragments get sorted before any
categorized fragments.0.1.0 — 2019-12-30Doesn’t really do anything yet.