Continue packaging (pawamoy#6)

Author: pawamoy

.gitignore

@@ -5,3 +5,5 @@ example2/
 example3/
 output.md
 __pycache__/
+src/dist/
+src/README.md

README.md

@@ -0,0 +1,69 @@
+# gitolog
+Automatic changelog generator. From git logs to change logs.
+
+- Installation: `sudo pip3 install gitolog`
+- 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
+$ gitolog --help
+usage: gitolog [-h] [-o OUTPUT] [-s {angular,atom,basic}]
+               [-t {angular,keepachangelog}] [-v]
+               REPOSITORY
+
+Command line tool for gitolog Python package.
+
+positional arguments:
+  REPOSITORY            The repository path, relative or absolute.
+
+optional arguments:
+  -h, --help            Show this help message and exit.
+  -o OUTPUT, --output OUTPUT
+                        Output to given file. Default: stdout.
+  -s {angular,atom,basic}, --style {angular,atom,basic}
+                        The commit style to match against.
+  -t {angular,keepachangelog}, --template {angular,keepachangelog}
+                        The Jinja2 template to use. Prefix with "path:" to
+                        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/
+[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/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

src/gitolog/cli.py

@@ -22,10 +22,10 @@
 from .build import Gitolog
 
 
-STYLES = ('basic', 'angular', 'atom')
+STYLES = ('angular', 'atom', 'basic')
 
 
-class Templates(set):
+class Templates(tuple):
     def __contains__(self, item):
         return item.startswith('path:') or super(Templates, self).__contains__(item)
 

src/pyproject.toml

@@ -0,0 +1,17 @@
+[build-system]
+requires = ["flit"]
+build-backend = "flit.buildapi"
+
+[tool.flit.metadata]
+module = "gitolog"
+author = "Timothée Mazzucotelli"
+author-email = "timothee.mazzucotelli@protonmail.com"
+home-page = "https://gitlab.com/pawamoy/gitolog"
+requires = ["jinja2"]
+description-file = "README.md"
+classifiers = [
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: ISC License (ISCL)",
+    "Programming Language :: Python :: 3",
+    "Topic :: Software Development"
+]