Updated Changelog class

.github/workflows/tests.yml

@@ -1,34 +1,34 @@
 name: Tests
 
-on: [push, pull_request]
-
-env:
-  POETRY_VIRTUALENVS_IN_PROJECT: "true"
+on: [ push, pull_request ]
 
 jobs:
   run-tests:
     runs-on: ubuntu-latest
     strategy:
+      fail-fast: true
       matrix:
-        python-version: [3.6, 3.7, 3.8]
+        python-version: [ 3.6, 3.7, 3.8, 3.9 ]
     steps:
       - uses: actions/checkout@v2
-      - name: Set up Python 3.6
+      - name: Set up Python
         uses: actions/setup-python@v2
         with:
           python-version: ${{ matrix.python-version }}
       - name: Install Poetry
-        run: |
-          curl -sSL https://raw.githubusercontent.com/python-poetry/poetry/master/get-poetry.py | python
-          echo "::add-path::$HOME/.poetry/bin"
-          source $HOME/.poetry/env
-          poetry --version
-      - name: Cache dependencies
+        uses: snok/[email protected]
+        with:
+          virtualenvs-in-project: true
+      - name: Load cached venv
+        id: cached-poetry-dependencies
         uses: actions/cache@v2
         with:
           path: .venv
-          key: ${{ hashFiles('poetry.lock') }}
+          key: venv-${{ runner.os }}-${{ hashFiles('**/poetry.lock') }}
       - name: Install dependencies
         run: poetry install --no-root
+        if: steps.cached-poetry-dependencies.outputs.cache-hit != 'true'
+      - name: Install kac library
+        run: poetry install --no-interaction
       - name: Test with pytest
         run: poetry run pytest

.gitignore

@@ -1,3 +1,6 @@
+.vscode/
+test.md
+
 # Created by .ignore support plugin (hsz.mobi)
 ### JetBrains template
 # Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio and WebStorm

CHANGELOG.md

@@ -5,6 +5,9 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
+### Changed
+- `template` command to `new`
+- Use semver library to parse versions
 
 ## [0.3.0] - 2020-04-05
 ### Added

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2019 Adam Walsh
+Copyright (c) 2021 Adam Walsh
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,35 +1,35 @@
-## kac
+![kac](https://atw.me/img/kac.svg)
+
+<hr>
+
 A command line tool for CHANGELOG files that follow the [Keep A Changelog][1] standard.
 
 ![Tests](https://github.com/atwalsh/kac/workflows/Tests/badge.svg)
 
 ### Usage
-Run `kac` in the same directory as your Changelog. By default, `kac` looks for a file called `CHANGELOG.md` 
+
+Run `kac` in the same directory as your Changelog. By default, `kac` looks for a file called `CHANGELOG.md`
 (case-insensitive).
 
-```bash
+```
 Usage: kac [OPTIONS] COMMAND [ARGS]...
 
+  A CLI tool for CHANGELOG files that follow the Keep-a-Changelog standard.
+
 Options:
   --help  Show this message and exit.
 
 Commands:
-  bump      Bump a Changelog.
-  copy      Copy a version's release text.
-  template  Create an empty CHANGELOG.md file.            
-
+  bump  Bump the latest version of a CHANGELOG file.
+  copy  Copy the latest release's changelog text.
+  init  Create an empty CHANGELOG file.
+  
 ```
 
 ## Limitations
+
 - Must be run in the same directory as your CHANGELOG file
-- Assumes you have changes in the "Unreleased" section 
 - Only works for semver
-- Only supports versions in the `MAJOR.MINOR.PATCH` format. A beta version ending in `-beta`, for example, 
-will fail.
-
-## To-Do
-- [ ] Add default text for versions with no notable changes
-- [ ] Undo bump
-- [ ] Support labels for pre-release and build metadata
+- `kac bump` can "format" (ex: remove extra empty lines) CHANGELOG files, this could be unfavorable for users
 
 [1]: https://keepachangelog.com/en/1.0.0/

kac/changelog/__init__.py

@@ -0,0 +1,2 @@
+from .changelog import Changelog
+from .release import Release, Unreleased