Saravanan666/pypi-org huggingface dataset:
Package: changelog-builder
changelog-builderA tool for creating markdown changelogs based on comments.ContentsInstallationUsageExamplesNotesLicenseInstallationUse the package managerpipto install changelog-builder.pipinstallchangelog-builderUsagechangelog-builder[path][filename][identifier][current-version][version-increment][files][includes][excludes]Parameterspaththe path to the project directory, defaults togetcwd()--filename -fnthe name of the changelog file, defaults tochangelog.md--identifier -idone or more strings that identify changes (whitespaces in line before are ignored), defaults to"# NEW" "# new"--curent-version -cvthree digits that specify the current version by major, minor an patch, defaults to0 0 0--version-increment -icthree digits that specify the increment by major, minor an patch, defaults to0 0 1[example: version of 4.2.1 with the increment 0.1.0 becomes 4.3.1]--files -fione or more file suffixes that get scanned (needs to start with a point), defaults to".py"these two do not work properly yet:--includes -inone or more files that get included additionally, defaults to[]--excludes -exone ore more files that get excluded, defaults to[]Running the changelog-builder in a project the first time will create a.changelog_builderfile which stores the parameters from above in json format and could be modified manually, but that will be probably rarely necessary, since every passed parameter will alter the settings file.ExamplesThe following code:defdivision(divident:int,divisior:int)->float:# NEW division by zero isn't allowed anymoreifdivisor==0:returnNone...would produce this changelog (while the# NEW division by zero isn't allowed anymoreline will be deleted above):Changelog0.0.12020-4-21division by zero isn't allowed anymoremultiple uses look like this:Changelog0.0.32020-4-27now in betathe screen size issue due to dpi settings should be resolved0.0.22020-4-22some new stufffixed#340.0.12020-4-21division by zero isn't allowed anymoreNotesA very popular use case might be setting a version in the parameters directly. In this case should thecurrent-versionparameter be set to the desired version and theversion-incrementto0 0 0. This set the next version to the desired valuebutwill also set theversion-incrementin the settings file which means every use in the future without theversion-incrementparameter set differently, will result in the version not to be increased.It is also possible to mark the identifiers (like# NEW) in your IDEPycharm: File →Â Settings →Â Editor →Â TODO →Â [the plus sign in the upper right] →Â Type in the regex pattern (like\bnew\b.*which will catch both# newand# NEWif case sensitive is unchecked) and specify the way you want it to be highlightedThis is certainly possible with other IDEs as well.Both the--includesas well as the--excludesparameter do not work properly at the moment.LicenseMITThis file was automatically created by the pypipal.setup_builder tool.
Package: changelog-cli
Changelog CLIA command line interface for managing your CHANGELOG.md files. Designed to make it easy to manage your repositories
release history according toKeep a Changelog.Installationinstall usingpipvia:pip install changelog-cliHow ToTo keep an accurate changelog, whenenever you commit a change that affects how end users use
your project, use this command line tool to add a line to the changelog.If you added a new feature, use something likechangelog new "added feature x". This will add a
line to yourCHANGELOG.mdunder the### Newsection.When you are ready for release, runchangelog releaseand that will infer the correct semantic
version based on the types of changes since the last release. For example yournewchange should
prompt aminor (0.X.0)release. Abreakschange would prompt amajor (X.0.0)version bump andfixorchangechanges
would prompt apatch (0.0.X).You can manually override what type of of release viachangelog release --minorusing the--patch,--minoror--majorflags.Commandschangelog init-> Creates a CHANGELOG.md with some basic documentation in it.changelog (new|change|fix|breaks) "<message>"-> adds a line to the appropriate sectionchangelog release (--major|minor|patch|suggest) (--yes)-> Cuts a release for the changelog, incrementing the version.changelog current-> returns the current version of the project based on the changelogchangelog suggest-> returns the suggested version of the next release based on the current logged changeschangelog --version-> get the current version of the changelog toolchangelog --help-> show helps screenShortcutIf you get tired of typing outchangelogfor every command, it can also be accessed via its shorthandclExample Usage>>> changelog current
1.4.1
>>> changelog new "add new feature x"
>>> changelog suggest
1.5.0
>>> changelog breaks "removing key feature y"
>>> cl release
Planning on releasing version 2.0.0. Proceed? [y/N]: n
>>> cl release --minor
>>> cl current
1.5.0Example Changelog as a result of the above# CHANGELOG

All notable changes to this project will be documented in this file.
This project adheres to [Semantic Versioning](http://semver.org/) and [Keep a Changelog](http://keepachangelog.com/).


## Unreleased
---

### New

### Changes

### Fixes

### Breaks


## 1.5.0 - (2017-06-09)
---

### New
* add new feature x

### Breaks
* remove key feature y


## 1.4.1 - (2017-05-29)
---

### Changes
* updating documentation


...
Package: changelogd
changelogdChangelogs without conflicts.Free software: MIT licenseDocumentation:https://changelogd.readthedocs.io.OverviewChangelogd allows teams to avoid merge conflicts for the changelog files.
Thechangelogdcontent is stored within multiple YAML files - one per each
changelog entry. Then, during application release, all input files are combined
into one release file. The script uses Jinja2 templates to generate one consistent
text file out of all input YAML files. The default output format is Markdown, but
by modifying the templates it can be changed into any text format you like.InstallationYou can installchangelogdviapipfromPyPI:$ pip install changelogdQuickstartFirst, initializechangelogdconfiguration.$changelogdinitCreatedmainconfigurationfile:changelog.d\config.yamlCopiedtemplatestochangelog.d\templatesThen, create changelog entries:$changelogdentry[1]:Features[feature][2]:Bugfixes[bug][3]:Documentationchanges[doc][4]:Deprecations[deprecation][5]:Otherchanges[other]>Selectmessagetype[1]:2>IssueID:100>Changelogmessage:ChangelogmessageCreatedchangelogentryatchangelog.d\bug.a3f13823.entry.yamlFinally, generate changelog file.$changelogdreleaseversion-number>Releasedescription(hitENTERtoomit):Thisistheinitialrelease.Savednewreleasedataintochangelog.d\releases\0.release-name.yamlGeneratedchangelogfiletochangelog.mdOutput file:# Changelog## version-number (2020-01-11)This is the initial release.### Bug fixes*[#100](http://repo/issues/100): Changelog message ([@user](user@example.com))DocumentationFor full documentation, please seehttps://changelogd.readthedocs.io/en/latest/.LicenseDistributed under the terms of theMITlicense, “changelogd” is free and open source softwareIssuesIf you encounter any problems, pleasefile an issuealong with a detailed description.History0.1.8 (2023-02-24)Features#37: Allow to set default values for entries.#36: Allow to add entry to the existing release.0.1.7 (2022-10-10)Minor improvements#26: Trim whitespace from multi-value fields.Other changes#25: Switch to GitHub Actions.0.1.6 (2022-09-06)Features#21: Add support for computed values.Minor improvements#7: Add a readme file that will be put into the changelogd config directory.Other changes#19: Remove invalid pytest option.#18: Add support for python 3.9 and 3.10, fix tests.0.1.5 (2020-01-30)Minor improvements#6: Add __main__.py file to allow invoking viapython -m changelogd.0.1.4 (2020-01-24)Minor improvements#5: Save timestamp with entry YAML, so the order won’t be affected by simple file modification.#4: Display entry title withSelect message typequestion.0.1.3 (2020-01-20)Features#2: Allow to control which user data will be saved in entries.#3: Automatically add new entries and releases to git.Other changes#1: Switch fromtoxtonoxfor running tests and tasks.0.1.2 (2020-01-17)Bug fixesFixed missing templates from theMANIFEST.in0.1.1 (2020-01-16)Initial release
Package: changelogdir
changelogdir============Generate a changelog from a directory structure to avoid merge conflicts.- Free software: GPLv3+- Documentation: https://carmenbianca.gitlab.io/changelogdir- Source code: https://gitlab.com/carmenbianca/changelogdir- PyPI: https://pypi.python.org/pypi/changelogdir- Python: 3.4+- Author: Carmen Bianca Bakker  <carmen@carmenbianca.eu>changelogdir is a simple utility that allows you to turn a directory structureinto a changelog file.  Every feature/bugfix/whatever gets its own file to listchanges in, thereby avoiding merge conflict crises such as described `here<https://gitlab.com/gitlab-org/gitlab-ce/issues/17826>`_.changelogdir is partially inspired by`Keep a Changelog <http://keepachangelog.com>`_.A simple example----------------Say we have a ``CHANGELOG.md`` in our master branch that looks like this::# Changelog## 1.0.0- Added support for TempleOS.And Developer A comes along and does the following in their branch::# Changelog## 1.0.0- Added support for TempleOS.- Deprecated support for Windows.And Developer B has this in their branch::# Changelog## 1.0.0- Added support for TempleOS.- Added support for Android.Then merging the two branches into master causes a merge conflict, and it's justa needless headache.changelogdir fixes this by putting those entries into individual files.  Thus,you'd end up with something looking like this::awesome-project├── CHANGELOG│   └── 1.0.0│       ├── android.md│       ├── templeos.md│       └── windows.md└── .changelogdirrc``.changelogdirrc`` contains::[changelogdir]directory = CHANGELOGfile_extension = mdh1 = # Changelogh2 = ## {name}``android.md`` contains::- Added support for Android.``templeos.md`` contains::- Added support for TempleOS.``windows.md`` contains::- Deprecated support for Windows.And when running ``changelogdir``, the following is generated in alphabeticalorder of the file names::~/awesome-project$ changelogdir# Changelog## 1.0.0- Added support for Android.- Added support for TempleOS.- Deprecated support for Windows.Of course, it might make more sense to put those three changes into a singlefile called ``platform-changes.md``, but this is merely for demonstration.Installation------------See :doc:`INSTALLATION`.Usage-----See :doc:`USAGE`.Why doesn't changelogdir have its changelog in the Python package?------------------------------------------------------------------Doing this would require having changelogdir installed to be able to builditself.  There is probably a way around this (just call changelogdir.pydirectly), but it'd be really ugly.As a compromise, it does generate its own changelog when creating and uploadingthe docs.  See :doc:`CHANGELOG`.
Package: changelogfromtags
changelogfromtagsChangelog generation has never been so easyFully automated changelog generation- This package generates a changelog file based ongit tags.Since you don't have to fill yourCHANGELOG.mdmanually now: just run the script, relax and take a cup of :coffee: before your next release! :tada:What’s the point of a changelog?To make it easier for users and contributors to see precisely what notable changes have been made between each release (or version) of the project.Why should I care?Because software tools are forpeople. "Changelogs make it easier for users and
contributors to see precisely what notable changes have been made between each
release (or version) of the project."→https://keepachangelog.comInstallationInstall the python package like:$ pip install changelogfromtags:warning:changelogfromtagshave been successuflly tested with git version >= 2.20.0
It doesn't works with git version 2.11.0 and under...UsageAssuming you have a message for git tags:$ git tag -l -n200
0.1.0           First release
    You retrieve the content of `git tag 0.1.0 -n200`
0.1.1           Deploy package changelogfromtags on pypiRunning with CLI:usage: changelogfromtags [-h] [-p [PREFIX]] [-t [TITLE]] [--tag TAG]
                         [--verbose]

Generate a change log from git tags.

optional arguments:
  -h, --help            show this help message and exit
  -p [PREFIX], --prefix [PREFIX]
                        Append a charachter before each line of the message
                        tag if it is not present.
  -t [TITLE], --title [TITLE]
                        Title in the header
  --tag TAG             Display entry for the given tag
  --verbose, -vExample$ changelogfromtags
Changelog
=========

0.1.1 (06/01/2020)
------------------
Deploy package changelogfromtags on pypi

0.1.0 (06/01/2020)
------------------
First release
You retrieve the content of `git tag 0.1.0 -n200`To add a prefix on entries if not present:$ changelogfromtags --prefix "- "
Changelog
=========

0.1.1 (06/01/2020)
------------------
- Deploy package changelogfromtags on pypi

0.1.0 (06/01/2020)
------------------
- First release
- You retrieve the content of `git tag 0.1.0 -n200`To the entry of a specific tag:$ changelogfromtags --tag 0.1.1
0.1.1 (06/01/2020)
------------------
- Deploy package changelogfromtags on pypiRunning with Dockerdockerrun-it--rm-v$(pwd):/appr4mb0/changelogfromtagsSee changelogfromtags docker image.Output exampleLook atCHANGELOG.mdfor this projectFeatures and advantages of this projectChangelog entries are directly taken from git tags messagesNo requirements except python and gitGenerate canonical, neat changelog file, with default sections that followbasic changelog guidelinesSave more time with git flow & auto-git-flow !Checkhttps://pypi.org/project/auto-git-flow/!AlternativesHere is awikipage list of alternativesthat I found. But none satisfied my requirements.If you know other projects, feel free to edit this Wiki page!Licensechangelogfromtags is released under theMIT License.
Package: changelog-generator
CHANGELOG generatorGenerate CHANGELOG from git commit historyInstallationpipinstallchangelog-generatorUsageRegular CHANGELOGchangelogRegular CHANGELOG in debug modechangelogdebugCHANGELOG in reverse orderchangelogreverseFlags-bGather commit notes specific to a branch. UsesDefault branchif not passed-fWrite the commit notes to a custom filename. Defaults toCHANGELOG-tTitle or index line for the file generated. Defaults toChange LogSamplerelease_notes.rstLintingPreCommitwill ensure linting, and the doc creation are run on every commit.Requirementpipinstallsphinx==5.1.1pre-commit==2.20.0recommonmark==0.7.1Usagepre-commitrun--all-filesPypi Packagehttps://pypi.org/project/changelog-generator/Runbookhttps://thevickypedia.github.io/changelog-generator/License & copyright© Vignesh Sivanandha Rao, Changelog GeneratorLicensed under theMIT License
Package: changeloggh
changelogghchangelogghis a command line tool
to generate and administrate changelog files for GitHub
according tohttps://keepachangelog.com/en/1.1.0/.InstallationInstall with pip:pipinstallchangelogghUpgrade with pip:pipinstall--upgradechangelogghUsageAlias clghHelp:changeloggh--helpVersion:changeloggh--versionInit CHANGELOG:changelogghinit<GitHubRepo>Add changes:changeloggh<added|changed|deprecated|removed|fixed|security>"entry 1""entry 2"...Bump version:changelogghbump<major|minor|patch>Release version:changelogghrelease<version>Import MD:changelogghimportPrint current version:changelogghlatestPrint CHANGELOG:changelogghprint--format<rich|json|text>DevelopmentInstalling poetry:pipinstallpoetryInstalling development dependencies:poetryinstallInstalling pre-commit:poetryrunpre-commitinstallRunning unit tests:poetryrunpython-mscripts.testsApplying code styles:poetryrunpython-mscripts.stylesRunning code analysis:poetryrunpython-mscripts.analyzeRunning code coverage:poetryrunpython-mscripts.coverageRunning cli usingpoetry:poetryrunchangelogghRelease a new versionCheckhttps://python-poetry.org/docs/cli/#versionpoetryrunpython-mscripts.bump--help
poetryrunpython-mscripts.bump<major|minor|patch>Why a lock file?A lot of tools (likeyarn,npm,poetry,etc) uselock filesto
ensures that installations remain identical and reproducible
across systems. Alock filessaves important metadata, so that is whychangelogghis using this approach. Thechangelog.lockfile
saves and structures changelog data in a json format.
It's highly recommended to commit thechangelog.lockfile into your repository.LimitationsDoes not support other format besidessemvermajor.minor.patch, ex.: 1.1.1.It needs achangelog.lock.Alternativeschangelog-cli
Package: changelogging
changeloggingBuilding changelogs from fragments.InstallingPython 3.8 or above is required.pipInstalling the library withpipis quite simple:$pipinstallchangeloggingAlternatively, the library can be installed from source:$gitclonehttps://github.com/nekitdev/changelogging.git$cdchangelogging$python-mpipinstall.poetryYou can addchangeloggingas a dependency with the following command:$poetryaddchangeloggingOr by directly specifying it in the configuration like so:[tool.poetry.dependencies]changelogging="^1.4.1"Alternatively, you can add it directly from the source:[tool.poetry.dependencies.changelogging]git="https://github.com/nekitdev/changelogging.git"DocumentationYou can find the documentationhere.SupportIf you need support with the library, you can send anemailor refer to the officialDiscord server.ChangelogYou can find the changeloghere.Security PolicyYou can find the Security Policy ofchangelogginghere.ContributingIf you are interested in contributing tochangelogging, make sure to take a look at theContributing Guide, as well as theCode of Conduct.Licensechangeloggingis licensed under the MIT License terms. SeeLicensefor details.
Package: changelog_helper
These Python2/3 compatible scripts can create and compile changelog
files from differentgitbranches without conflicts.Inspired by GitLab team approach to changelogs.https://docs.gitlab.com/ee/development/changelog.htmlHow to install:pip installchangelog-helperInfoAdding changelog entities:add-changelog.py [-h] [--author AUTHOR] [--amend] [--force] [title]

Generate a changelog entry file in git project root.

positional arguments:
  title

optional arguments:
  -h, --help       show this help message and exit
  --author AUTHOR
  --amend
  --forceRelease version and compile changelog:release-changelog [-h] [--inline INLINE] [--rebuild] [version]

Generate CHANGELOG.md file from changelog yml files.

positional arguments:
  version          New version, in format like v5.6.7

optional arguments:
  -h, --help       show this help message and exit
  --inline INLINE  Inline minor release, with single change
  --rebuildYou can move your old changelog tochangelogs/archive.md, and it
will be appended to CHANGELOG.md
Package: changelog-keeper
Changelog KeeperCommand line utility for keeping your changelog tidyAbout the projectThis tool aims to:make your changelog file standardized; andreduce the time spent on updating the changelog file by providing a suite of basic commands.The Changelog standard is based on thekeep-a-changelogconvention with few adjustments, described inthis document.It is also possible (with some additional scripting/tooling) to incorporate this utility into yourContinuous Integration & Continuous Deliveryroutines. There are few things to consider, mentioned inthis document.Getting startedPrerequisitesPython >= 3.7PipInstallation# general installationpipinstallchangelog-keeper# with specific versionpipinstallchangelog-keeper==1.0.0UsageChangelog Keeper provides five simple commands allowing basic operations on the changelog file:# Create new, empty changelog fileclkprcreate[-fPATH]# Add new entry to the changelog fileclkpradd[-fPATH]CHANGE_TYPEENTRY# Validate and (if needed and possible) fix the changelog fileclkprcheck[-fPATH]# Release a version (with optional link)clkprrelease[-fPATH][-rURL]VERSION_NAME# Yank released versionclkpryank[-fPATH]VERSION_NAME# For more details, one can check the help messages for the tool: `clkpr -h`# and for a particular command: `clkpr <command> -h`ContributingPlease have a look intoCONTRIBUTINGfile for detailed suggestions regarding project contribution.LicenseDistributed under theMIT License. SeeLICENSEfile for more information.
Package: changelog-machine
Changelog machineGetting startedInstallpip3installchangelog-machine

changelog-machine-h# will print the help# ORpython3-mchangelog_machine-h# will print the helpCreate new entrychangelog-machineentry-m"Message of the entry"for further options see:changelog-machineentry-hGenerate changelog for new releaseThe new release with its entries will be inserted in the existingCHNAGELOG.mdor create a new on in order that the highest version will be on top.changelog-machinechangelog--releaseVersion"1.0.0"
Package: changelog-manager
changelog-managerhttps://pypi.org/project/changelog-manager/changelog_manager helps you manage your changelog.This project usesKeep a ChangelogIt mainly useskeepachangeloglibrary and adds a CLI above it.How to install it?pip install changelog_managerHow to use it?❯ changelog-manager --help
Usage: changelog-manager [OPTIONS] COMMAND [ARGS]...

Options:
  --version  Show the version and exit.
  --help  Show this message and exit.

Commands:
  add      Add a new changelog entry.
  current  Get current version from changelog
  display  display changes according to changelog
  release  Release unrealeased items in changelog
  suggest  Suggest future version from changelogreleaserelease the changelogUpdate version inchangelog_manager/_version.pyCreate a commit and tag using the versionrunpython setup.py sdist bdist_wheelruntwine upload -r testpypi dist/*runtwine upload -r pypi dist/*
Package: changelogmd
py-changelogmdPython module and CLI tool for CHANGELOG.md manipulation.Installpython3 -m pip install changelogmdUsagefromchangelogmdimportChangelogchangelog=Changelog("CHANGELOG.md")# List available versionsprint(list(changelog.versions))# Print full Markdownprint(str(changelog))# Print full Markdown of latest versionprint(str(changelog.versions[0]))# Bump release version from UNRELEASED versionchangelog.bump()UNRELEASED changesUnreleased changes are stored in the CHANGELOG.md file as top-most version# Changelog## [UNRELEASED]### Added-New Feature added### Removed-This will cause a minor version bump
Package: changelog-md
install with pippython3-mpipinstallchangelog-mdinstall with Poetrypoetry add changelog-mdexecution information:This script aim to provide changelogs on git-tracked projects.
Runchangelog.pyscript in your directory
and it'll generate the changelog file.
In order to obtain actual changelog, run:You can use git changelog from command line directly:# ... code on projectgitcommit#add your commit message on work you've donepython3-mchangelog_mdvX.Y.Z"Annotation for this version"#generate changeloggitaddchangelog.md#stage the changelog to current commitgitcommit--amend#add the changelog to current commit, leave commit message as is.gittag-avX.Y.Z-m"Annotation for this version"#add the tag you've set earlier in changelog.gitpush--follow-tags#publish your changes and the new tag.Or you can elaborate your workflow python scripts
to use changelog_md as a python module:# CICD_script.py# ... do some CICD workfromchangelog_mdimportloggerl=logger('vX.Y.Z','Annotation for this version')#create logger instancel.make()#print the log# ... do other CICD workMore actual information on colophon of scripts:#actual information on colophon:python3-mchangelog_md--helpcorrect commit messages:To make this scripts work properly, your commit messages
should look like any of this:[feature] feature description here
[fix] fix description
[changelog] minor changes description
[internal] this section will be generated only if --internal argument is given.
This commit message string will be ommited from changelog.Releases:Any tagged commit will be interpreted as release.
To create tag, write:git tag -a v<version>
... tag anotation ...
git push --follow-tagsAny commit above the last tag will be marked as tag provided
in command line arguments and annotated accordingly.