Skip to main content
Join the official 2020 Python Developers SurveyStart the survey!

A simple changelog parser

Project description

Simple Changes

MPL Python PyPI version

Simple Changes is a dead-simple changelog format that keeps track of changes and call them programmatically. The file format is dead-easy to follow, and you can use this package to parse the file and get information in the changelog. Simple Changes is used in Unscripted to parse the game's changelog and present the latest version information to players, but this library can be used anywhere.

Requirements

  • Python 2.7+
  • Poetry package manager (for building)

Getting started

Quick Start: Install on PyPI

Simple Changes is bundled in Unscripted, but you can install it into your projects anywhere from PyPI with pip:

pip install simplechanges

Install from source

To install Simple Changes from the source code, first clone the repository from GitHub via git clone. You'll also need to install Poetry. In the root of the source, run the following commands:

- poetry install
- poetry build

The resulting wheel files will be available in the dist directory.

Syntax

  • Comments are wrapped in /* and */.
  • Versions are denoted by square brackets: [v1.0.0].
  • Notes are denoted with dashes in the beginning and end with a newline.

Note: To get the latest version to work in the parser, always place the latest version at the top of the file.

Example file

/*
    Changelog Test
*/

[v1.0.1]
- Made a small bugfix.

[v1.0.0]
- Launched!
- I ate cheese.

Usage

Using the package is relatively easy. To get the latest version in the changelog, assuming the changelog builds up:

from simplechanges import SimpleChangesParser

changelog = SimpleChangesParser("changelog.changes")
changelog.parse()
version, notes = changelog.latest

After parsing, you also can browse for a specific version:

from simplechanges import SimpleChangesParser

changelog = SimpleChangesParser("changelog.changes")
changelog.parse()
version, notes = changelog.versions["v1.0.0"]

License

This code is licensed under the Mozilla Public License, v2.0.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for simplechanges, version 0.1.0
Filename, size File type Python version Upload date Hashes
Filename, size simplechanges-0.1.0-py2.py3-none-any.whl (9.8 kB) File type Wheel Python version py2.py3 Upload date Hashes View
Filename, size simplechanges-0.1.0.tar.gz (9.2 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page