From 1861f7a4b69eddc24f8771996debbb9bbc1516a7 Mon Sep 17 00:00:00 2001 From: drewcassidy Date: Fri, 7 May 2021 15:48:07 -0700 Subject: [PATCH] Consistancy with yaclog --- .github/workflows/python-publish.yml | 2 +- CHANGELOG.md | 4 ++++ README.md | 2 ++ setup.cfg | 2 +- yaclog_ksp/__main__.py | 11 +++++------ 5 files changed, 13 insertions(+), 8 deletions(-) diff --git a/.github/workflows/python-publish.yml b/.github/workflows/python-publish.yml index 218cc60..cd82cd8 100644 --- a/.github/workflows/python-publish.yml +++ b/.github/workflows/python-publish.yml @@ -1,7 +1,7 @@ # This workflow will upload a Python Package using Twine when a release is created # For more information see: https://help.github.com/en/actions/language-and-framework-guides/using-python-with-github-actions#publishing-to-package-registries -name: Upload Python Package +name: build on: [ push, pull_request ] jobs: diff --git a/CHANGELOG.md b/CHANGELOG.md index cc132fa..24f082c 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,6 +7,8 @@ All notable changes to this project will be documented in this file. ### Changed - Updated API for yaclog to 1.0.0 +- Renamed '--input' option to '--path' for consistency with yaclog, and added an environment variable for its value + ## 0.2.0 - 2021-05-06 @@ -16,6 +18,7 @@ All notable changes to this project will be documented in this file. - Tweaks and fixes to project metadata in setup.cfg. - Marked version compatibility with yaclog. + ## 0.1.1 - 2021-04-16 yaclog-ksp is [now available on PyPi!](https://pypi.org/project/yaclog-ksp/) @@ -24,6 +27,7 @@ yaclog-ksp is [now available on PyPi!](https://pypi.org/project/yaclog-ksp/) - Generator will now use change values instead of nodes when possible for more concise output files. + ## 0.1.0 - 2021-04-16 First release diff --git a/README.md b/README.md index 1a4cc75..b2ebb31 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,7 @@ # yaclog-ksp +[![PyPI version](https://badge.fury.io/py/yaclog-ksp.svg)](https://badge.fury.io/py/yaclog-ksp) + A command line tool based on [yaclog] for converting markdown changelogs to [KerbalChangelog] config files. ![a yak who is a log](https://github.com/drewcassidy/yaclog/raw/main/logo.png) diff --git a/setup.cfg b/setup.cfg index 1728970..bdb759d 100644 --- a/setup.cfg +++ b/setup.cfg @@ -10,7 +10,7 @@ long_description_content_type = text/markdown keywords = changelog, commandline, markdown, KSP classifiers = - Development Status :: 4 - Beta + Development Status :: 5 - Production/Stable Intended Audience :: Developers License :: OSI Approved :: GNU Affero General Public License v3 Operating System :: OS Independent diff --git a/yaclog_ksp/__main__.py b/yaclog_ksp/__main__.py index b5e9c4c..93d27e9 100644 --- a/yaclog_ksp/__main__.py +++ b/yaclog_ksp/__main__.py @@ -23,17 +23,16 @@ from yaclog_ksp.cfgnode import ConfigNode @click.command() -@click.option('-i', '--input', 'inpath', - default='CHANGELOG.md', show_default=True, - type=click.Path(readable=True, exists=True, dir_okay=False), - help="Input markdown file to read from.") +@click.option('--path', envvar='YACLOG_PATH', default='CHANGELOG.md', show_default=True, + type=click.Path(dir_okay=False, writable=True, readable=True), + help='Location of the changelog file.') @click.option('-o', '--output', 'outpath', default=None, type=click.Path(writable=True, dir_okay=False), help="Output file to write to. Uses 'GameData/{name}/Versioning/{name}ChangeLog.cfg' by default.") @click.option('-n', '--name', help="The name of the mod. Derived from the current directory by default.") @click.version_option() -def main(inpath, outpath, name): +def main(path, outpath, name): """ Converts markdown changelogs to KSP changelog configs.""" if not name: # try to guess name from current directory @@ -48,7 +47,7 @@ def main(inpath, outpath, name): # default is in GameData/{name}/Versioning/{name}ChangeLog.cfg outpath = pathlib.Path('GameData', modslug, 'Versioning', modslug + 'ChangeLog.cfg') - log = yaclog.read(inpath) + log = yaclog.read(path) node = ConfigNode() # find metadata table rows