Skip to content
This repository has been archived by the owner on Jul 15, 2019. It is now read-only.

siku2/Loglette

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

26 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Loglette

Build Status Codacy Badge codecov

This is an unfinished project and doesn't even have a proper documentation yet so you might want to leave for now (while you still can) and come back later

A tool for parsing changelogs into all kinds of formats.

Loglette Format

Loglette isn't just a changelog parser, it also aims to be a changelog format. You can read about the Loglette Format Specification (v1) here. Of course Loglette also parses other formats.

Installing

Nice and easy

pip install loglette

There are multiple extra dependencies for various reasons. If you want to have it all you can use all (pip install loglette[all]) which installs all possible dependencies.

Using Pipenv

Download the repository and use pipenv install

Usage

loglette [OPTIONS] file

Options

short long value description
-f --format (Optional) Formatter Alias Use the given Formatter to format the changelog.
Defaults to Markdown
-p --parser (Optional) Parser Alias Specify the parser to use when parsing the file.
When omitted Loglette tries to guess the correct parser.