Skip to main content

A changelog parser

Project description

Copyright (c) 2018 Simon Berger

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

Description: # Loglette

[![Build Status](https://travis-ci.org/siku2/Loglette.svg?branch=master)](https://travis-ci.org/siku2/Loglette)
[![Codacy Badge](https://api.codacy.com/project/badge/Grade/5481332c7e354747983d9233023bdf37)](https://www.codacy.com/app/siku2/Loglette?utm_source=github.com&utm_medium=referral&utm_content=siku2/Loglette&utm_campaign=Badge_Grade)
[![codecov](https://codecov.io/gh/siku2/Loglette/branch/master/graph/badge.svg)](https://codecov.io/gh/siku2/Loglette)

> 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][loglette-spec].
Of course Loglette also parses [other formats][Formatter].

## 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.<br>Defaults to [Markdown][Formatter-Markdown]
| -p | --parser | *(Optional)* [Parser] Alias | Specify the parser to use when parsing the file.<br>When omitted Loglette tries to guess the correct parser.





[loglette-spec]: https://siku2.github.io/Loglette/spec "Format Specification"

[Formatter]: https://siku2.github.io/Loglette/formatters "Formatters"
[Formatter-Markdown]: https://siku2.github.io/Loglette/formatters#markdown-formatter "Markdown Formatter"
[Parser]: https://siku2.github.io/Loglette/parsers "Parsers"
Keywords: changelog
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Description-Content-Type: text/markdown
Provides-Extra: html
Provides-Extra: all

Project details


Release history Release notifications

This version

0.1.0

Download files

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

Files for loglette, version 0.1.0
Filename, size File type Python version Upload date Hashes
Filename, size loglette-0.1.0.tar.gz (11.2 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page