Skip to main content

Release exporter for GitHub and GitLab.

Project description

Release Exporter

Exports your releases to a markdown based on keep a changelog and markdownlint. This CLI application currently supports GitHub and GitLab.

Install

pip install release-exporter

Or download this repository and type in the following in your terminal/cmd

python setup.py install

Usage

In your terminal/cmd, change to the folder where you repository is located and do the following:

rex --token <your token> markdown

That’s it. You should see a CHANGELOG.md in your folder.

Advance Usage

Release exporter has the following options

Usage: rex [OPTIONS] COMMAND [ARGS]...

Options:
  --token TEXT     Token number if its a private repository.
  --url TEXT       URL of your repository. This is optional if your current
                   directory has .git folder with remote url.
  --location TEXT  Local location of your repository.
  --version
  --help           Show this message and exit.

Commands:
  json      Creates JSON file.
  markdown  Creates markdown file.

If you don’t have a repository on your computer but you still want to generate a change log you can manually add your repository URL as following:

rex markdown --token <your token> --url <your url>

if you want to save it in a custom location you can use --location <location>.

You can also export your releases to JSON file by just replacing markdown with json.

Customising the Output

Coming soon.

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog and this project adheres to Semantic Versioning.

Unreleased

1.0.3 - 2018-01-16

Changed

  • v removed from the version number

  • pypandoc usage removed and *.rst format added

  • Unwanted encoding removed

1.0.2 - 2018-01-16

Added

  • Long description and changelog added to setup.py

Fixed

  • Typo

  • Exception error type changed to ImportError

v1.0.1 - 2018-01-16

Added

  • Unreleased tag added to the template and GitHub

  • Unreleased tag added to GitHub

Fixed

  • Tag missing in GitHub JSON fixed

  • Tag missing in GitLab JSON fixed

v1.0 - 2018-01-15

Initial release.

Project details


Download files

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

Source Distribution

release-exporter-1.0.3.tar.gz (9.9 kB view hashes)

Uploaded Source

Built Distribution

release_exporter-1.0.3-py3-none-any.whl (14.2 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page