chore: sed 's/gitolog/git-changelog/'

Author: pawamoy

CHANGELOG.md

@@ -4,34 +4,34 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
-## [0.1.1](https://gitlab.com/pawamoy/gitolog/tags/0.1.1) ([compare](https://gitlab.com/pawamoy/gitolog/compare/0.1.0...0.1.1))
+## [0.1.1](https://gitlab.com/pawamoy/git-changelog/tags/0.1.1) ([compare](https://gitlab.com/pawamoy/git-changelog/compare/0.1.0...0.1.1))
 
 ### Fixed
-- Fix build with MANIFEST.in, add license file ([013fb69](https://gitlab.com/pawamoy/gitolog/commit/013fb691826924d6f71b4159a8fa650e40324db3)).
+- Fix build with MANIFEST.in, add license file ([013fb69](https://gitlab.com/pawamoy/git-changelog/commit/013fb691826924d6f71b4159a8fa650e40324db3)).
 
 ### Misc
-- Improve readability ([5e590f6](https://gitlab.com/pawamoy/gitolog/commit/5e590f6ac62b23e608a507e08123efba3b0f7e0d)).
+- Improve readability ([5e590f6](https://gitlab.com/pawamoy/git-changelog/commit/5e590f6ac62b23e608a507e08123efba3b0f7e0d)).
 
 
-## [0.1.0](https://gitlab.com/pawamoy/gitolog/tags/0.1.0) ([compare](https://gitlab.com/pawamoy/gitolog/compare/83845fe8d7deb85a2e093fe68a4b6a48b6d8e446...0.1.0)) - 2018-06-27
+## [0.1.0](https://gitlab.com/pawamoy/git-changelog/tags/0.1.0) ([compare](https://gitlab.com/pawamoy/git-changelog/compare/83845fe8d7deb85a2e093fe68a4b6a48b6d8e446...0.1.0)) - 2018-06-27
 
 ### Added
-- Add github/gitlab regexes ([584fd73](https://gitlab.com/pawamoy/gitolog/commit/584fd73ec88ac51abbf8555d8f78b7144529e6b3)).
+- Add github/gitlab regexes ([584fd73](https://gitlab.com/pawamoy/git-changelog/commit/584fd73ec88ac51abbf8555d8f78b7144529e6b3)).
 
 ### Fixed
-- Fix patch bump ([8470e69](https://gitlab.com/pawamoy/gitolog/commit/8470e695128d9892296acdd31c404d85add68983)).
-- Fix refs parsing ([8c77cb7](https://gitlab.com/pawamoy/gitolog/commit/8c77cb736971473837384a8238c3c53886d77c75)).
+- Fix patch bump ([8470e69](https://gitlab.com/pawamoy/git-changelog/commit/8470e695128d9892296acdd31c404d85add68983)).
+- Fix refs parsing ([8c77cb7](https://gitlab.com/pawamoy/git-changelog/commit/8c77cb736971473837384a8238c3c53886d77c75)).
 
 ### Misc
-- Continue packaging (#6) ([a29af2c](https://gitlab.com/pawamoy/gitolog/commit/a29af2cf990edf950b55a46ebea164ab068c9aec)).
-- Finish packaging (#6) ([e92b492](https://gitlab.com/pawamoy/gitolog/commit/e92b4923a60d561c38150331dac9cd2e3ba6c130)).
-- Implement reference parsing ([a9b4a89](https://gitlab.com/pawamoy/gitolog/commit/a9b4a89cd2737056166feb7a46da971549f1ffed)).
-- Improve angular template, improve style/refs system ([5b87d48](https://gitlab.com/pawamoy/gitolog/commit/5b87d48acdf3aa0f5cc2731f48e372c4065d9f9b)).
-- Initial commit ([83845fe](https://gitlab.com/pawamoy/gitolog/commit/83845fe8d7deb85a2e093fe68a4b6a48b6d8e446)).
-- Package code (#6) ([1219eaf](https://gitlab.com/pawamoy/gitolog/commit/1219eafd02521f6f6ab942a02b7a7aee3d664143)).
-- Update changelog for version 0.1.0 ([14edcaf](https://gitlab.com/pawamoy/gitolog/commit/14edcaf078d02c42abf1692664c620c509df88a0)).
-- Update changelog for version 0.1.0 ([610633d](https://gitlab.com/pawamoy/gitolog/commit/610633da8a569e7f2966f1675a30aca651563e0b)).
-- Update changelog for version 0.1.0 ([2eaaa2e](https://gitlab.com/pawamoy/gitolog/commit/2eaaa2e76fc35d111517ecd0a15daf65e705723c)).
-- Work in progress ([27a60e8](https://gitlab.com/pawamoy/gitolog/commit/27a60e80e9a8308b88942311184346b1bfa4b0a8)).
+- Continue packaging (#6) ([a29af2c](https://gitlab.com/pawamoy/git-changelog/commit/a29af2cf990edf950b55a46ebea164ab068c9aec)).
+- Finish packaging (#6) ([e92b492](https://gitlab.com/pawamoy/git-changelog/commit/e92b4923a60d561c38150331dac9cd2e3ba6c130)).
+- Implement reference parsing ([a9b4a89](https://gitlab.com/pawamoy/git-changelog/commit/a9b4a89cd2737056166feb7a46da971549f1ffed)).
+- Improve angular template, improve style/refs system ([5b87d48](https://gitlab.com/pawamoy/git-changelog/commit/5b87d48acdf3aa0f5cc2731f48e372c4065d9f9b)).
+- Initial commit ([83845fe](https://gitlab.com/pawamoy/git-changelog/commit/83845fe8d7deb85a2e093fe68a4b6a48b6d8e446)).
+- Package code (#6) ([1219eaf](https://gitlab.com/pawamoy/git-changelog/commit/1219eafd02521f6f6ab942a02b7a7aee3d664143)).
+- Update changelog for version 0.1.0 ([14edcaf](https://gitlab.com/pawamoy/git-changelog/commit/14edcaf078d02c42abf1692664c620c509df88a0)).
+- Update changelog for version 0.1.0 ([610633d](https://gitlab.com/pawamoy/git-changelog/commit/610633da8a569e7f2966f1675a30aca651563e0b)).
+- Update changelog for version 0.1.0 ([2eaaa2e](https://gitlab.com/pawamoy/git-changelog/commit/2eaaa2e76fc35d111517ecd0a15daf65e705723c)).
+- Work in progress ([27a60e8](https://gitlab.com/pawamoy/git-changelog/commit/27a60e80e9a8308b88942311184346b1bfa4b0a8)).
 
 

README.md

@@ -1,7 +1,7 @@
-# gitolog
+# git-changelog
 Automatic changelog generator. From git logs to change logs.
 
-- Installation: `sudo pip3 install gitolog`
+- Installation: `sudo pip3 install git-changelog`
 - Features:
   - [Jinja2][jinja2] templates!
     You get full control over the rendering.
@@ -27,12 +27,12 @@ Automatic changelog generator. From git logs to change logs.
 ## Command-line
 
 ```console
-$ gitolog --help
-usage: gitolog [-h] [-o OUTPUT] [-s {angular,atom,basic}]
-               [-t {angular,keepachangelog}] [-v]
-               REPOSITORY
+$ git-changelog --help
+usage: git-changelog [-h] [-o OUTPUT] [-s {angular,atom,basic}]
+                     [-t {angular,keepachangelog}] [-v]
+                     REPOSITORY
 
-Command line tool for gitolog Python package.
+Command line tool for git-changelog Python package.
 
 positional arguments:
   REPOSITORY            The repository path, relative or absolute.
@@ -48,6 +48,7 @@ optional arguments:
                         specify the path to a directory containing a file
                         named "changelog.md".
   -v, --version         Show the current version of the program and exit.
+
 ```
 
 [jinja2]:                 http://jinja.pocoo.org/
@@ -60,10 +61,10 @@ optional arguments:
 [github-refs]:            https://help.github.com/articles/autolinked-references-and-urls/
 [gitlab-refs]:            https://docs.gitlab.com/ce/user/markdown.html#special-gitlab-references
 
-[issue-1]: https://gitlab.com/pawamoy/gitolog/issues/1
-[issue-2]: https://gitlab.com/pawamoy/gitolog/issues/2
-[issue-3]: https://gitlab.com/pawamoy/gitolog/issues/3
-[issue-4]: https://gitlab.com/pawamoy/gitolog/issues/4
-[issue-5]: https://gitlab.com/pawamoy/gitolog/issues/5
-[issue-6]: https://gitlab.com/pawamoy/gitolog/issues/6
-[issue-7]: https://gitlab.com/pawamoy/gitolog/issues/7
+[issue-1]: https://gitlab.com/pawamoy/git-changelog/issues/1
+[issue-2]: https://gitlab.com/pawamoy/git-changelog/issues/2
+[issue-3]: https://gitlab.com/pawamoy/git-changelog/issues/3
+[issue-4]: https://gitlab.com/pawamoy/git-changelog/issues/4
+[issue-5]: https://gitlab.com/pawamoy/git-changelog/issues/5
+[issue-6]: https://gitlab.com/pawamoy/git-changelog/issues/6
+[issue-7]: https://gitlab.com/pawamoy/git-changelog/issues/7

docs/spelling_wordlist.txt

@@ -0,0 +1 @@
+pawamoy

scripts/check-docs-spelling.sh

@@ -0,0 +1,5 @@
+#!/usr/bin/env bash
+if poetry run sphinx-build -E -b spelling docs build/docs 2>/dev/null | sed 's/^/docs\//' | grep '\.rst:[0-9]'; then
+  exit 1
+fi
+exit 0

scripts/gen-readme-data.py

@@ -0,0 +1,28 @@
+#!/usr/bin/env python
+
+import json
+# import argparse
+
+from git_changelog.cli import get_parser
+
+parser = get_parser()
+
+output = {
+    "main_usage": parser.format_help(),
+    "commands": []
+}
+
+# subparser_actions = [
+#     action for action in parser._actions
+#     if isinstance(action, argparse._SubParsersAction)
+# ]
+#
+# for subparser_action in subparser_actions:
+#     for choice, subparser in subparser_action.choices.items():
+#         output["commands"].append({
+#             "name": choice,
+#             "usage": subparser.format_help()
+#         })
+
+json_output = json.dumps(output)
+print(json_output)

scripts/templates/README.md

@@ -0,0 +1,50 @@
+# git-changelog
+Automatic changelog generator. From git logs to change logs.
+
+- Installation: `sudo pip3 install git-changelog`
+- Features:
+  - [Jinja2][jinja2] templates!
+    You get full control over the rendering.
+    Built-in [Keep a Changelog][keep-a-changelog] and [Angular][angular] templates
+    (also see [Conventional Changelog][conventional-changelog]).
+  - Commit styles/conventions parsing.
+    Built-in [Angular][angular-style], [Atom][atom-style] and basic styles.
+  - Git service/provider agnostic,
+    plus references parsing (issues, commits, etc.).
+    Built-in [GitHub][github-refs] and [Gitlab][gitlab-refs] support.
+  - Understands [Semantic Versioning][semantic-versioning]:
+    major/minor/patch for versions and commits.
+    Guesses next version based on last commits.
+- Todo:
+  - [Plugin architecture][issue-7],
+    to support more commit styles and git services.
+  - [Template context injection][issue-4],
+    to furthermore customize how your changelog will be rendered.
+  - [Easy access to "Breaking Changes"][issue-1] in the templates.
+  - [Update changelog in-place][issue-2], paired with
+    [commits/dates/versions range limitation ability][issue-3].
+
+## Command-line
+
+```console
+$ git-changelog --help
+{{ main_usage }}
+```
+
+[jinja2]:                 http://jinja.pocoo.org/
+[keep-a-changelog]:       http://keepachangelog.com/en/1.0.0/
+[angular]:                https://github.com/angular/angular/blob/master/CHANGELOG.md
+[conventional-changelog]: https://github.com/conventional-changelog/conventional-changelog
+[semantic-versioning]:    http://semver.org/spec/v2.0.0.html
+[atom-style]:             https://github.com/atom/atom/blob/master/CONTRIBUTING.md#git-commit-messages
+[angular-style]:          https://github.com/angular/angular/blob/master/CONTRIBUTING.md#commit
+[github-refs]:            https://help.github.com/articles/autolinked-references-and-urls/
+[gitlab-refs]:            https://docs.gitlab.com/ce/user/markdown.html#special-gitlab-references
+
+[issue-1]: https://gitlab.com/pawamoy/git-changelog/issues/1
+[issue-2]: https://gitlab.com/pawamoy/git-changelog/issues/2
+[issue-3]: https://gitlab.com/pawamoy/git-changelog/issues/3
+[issue-4]: https://gitlab.com/pawamoy/git-changelog/issues/4
+[issue-5]: https://gitlab.com/pawamoy/git-changelog/issues/5
+[issue-6]: https://gitlab.com/pawamoy/git-changelog/issues/6
+[issue-7]: https://gitlab.com/pawamoy/git-changelog/issues/7

scripts/update-spelling-wordlist.sh

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+
+cat docs/spelling_wordlist.txt > docs/tmpspell.txt
+grep '<w>' .idea/dictionaries/pawamoy.xml | sed -r 's/ *<w>(.*)<\/w>/\1/' >> docs/tmpspell.txt
+sort -u docs/tmpspell.txt > docs/spelling_wordlist.txt
+rm docs/tmpspell.txt

src/git_changelog/__main__.py

@@ -1,5 +1,5 @@
 """
-Entrypoint module, in case you use `python -mgitolog`.
+Entrypoint module, in case you use `python -m git_changelog`.
 
 Why does this file exist, and why __main__? For more info, read:
 
@@ -10,7 +10,7 @@
 
 import sys
 
-from gitolog.cli import main
+from git_changelog.cli import main
 
 if __name__ == "__main__":
     main(sys.argv[1:])

src/git_changelog/build.py

@@ -160,7 +160,7 @@ def __init__(self, repository, provider=None, style=None):
             try:
                 style = self.STYLE[style]()
             except KeyError:
-                print("gitolog: no such style available: %s, " "using default style" % style, file=sys.stderr)
+                print("git-changelog: no such style available: %s, " "using default style" % style, file=sys.stderr)
                 style = BasicStyle()
         elif style is None:
             style = BasicStyle()

src/git_changelog/cli.py

@@ -3,24 +3,24 @@
 
 Why does this file exist, and why not put this in __main__?
 
-  You might be tempted to import things from __main__ later,
-  but that will cause problems: the code will get executed twice:
+You might be tempted to import things from __main__ later,
+but that will cause problems: the code will get executed twice:
 
-  - When you run `python -mgitolog` python will execute
-    ``__main__.py`` as a script. That means there won't be any
-    ``gitolog.__main__`` in ``sys.modules``.
-  - When you import __main__ it will get executed again (as a module) because
-    there's no ``gitolog.__main__`` in ``sys.modules``.
+- When you run `python -m git_changelog` python will execute
+  ``__main__.py`` as a script. That means there won't be any
+  ``git_changelog.__main__`` in ``sys.modules``.
+- When you import __main__ it will get executed again (as a module) because
+  there's no ``git_changelog.__main__`` in ``sys.modules``.
 
-  Also see (1) from http://click.pocoo.org/5/setuptools/#setuptools-integration
+Also see http://click.pocoo.org/5/setuptools/#setuptools-integration.
 """
 
 from __future__ import print_function
 
 import argparse
 import sys
 
-from . import __version__, templates
+from . import templates
 from .build import Changelog
 
 STYLES = ("angular", "atom", "basic")
@@ -33,7 +33,7 @@ def __contains__(self, item):
 
 def get_parser():
     """Return a parser for the command-line arguments."""
-    parser = argparse.ArgumentParser(add_help=False, description="Command line tool for gitolog Python package.")
+    parser = argparse.ArgumentParser(add_help=False, prog="git-changelog", description="Command line tool for git-changelog Python package.")
 
     parser.add_argument("repository", metavar="REPOSITORY", help="The repository path, relative or absolute.")
 
@@ -64,7 +64,7 @@ def get_parser():
         "-v",
         "--version",
         action="version",
-        version="gitolog %s" % __version__,
+        version="git-changelog 0.1.0",
         help="Show the current version of the program and exit.",
     )
     return parser
@@ -80,7 +80,7 @@ def main(args=None):
         try:
             template = templates.get_custom_template(path)
         except FileNotFoundError:
-            print("gitolog: no such directory, " "or missing changelog.md: %s" % path, file=sys.stderr)
+            print("git-changelog: no such directory, " "or missing changelog.md: %s" % path, file=sys.stderr)
             return 1
     else:
         template = templates.get_template(args.template)