Metadata-Version: 2.0
Name: release-exporter
Version: 1.0.2
Summary: Release exporter for GitHub and GitLab.
Home-page: https://github.com/akshaybabloo/release-exporter
Author: Akshay Raj Gollahalli
Author-email: akshay@gollahalli.com
License: MIT
Description-Content-Type: UNKNOWN
Keywords: changelog,releases
Platform: UNKNOWN
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Intended Audience :: Developers
Classifier: Environment :: Console
Classifier: Development Status :: 5 - Production/Stable
Classifier: Topic :: Utilities
Requires-Dist: tabulate
Requires-Dist: click (==6.7)
Requires-Dist: requests (==2.18.4)
Requires-Dist: python-dateutil
Requires-Dist: git-url-parse (==1.0.2)

Release Exporter
================

Exports your releases to a markdown based on `keep a
changelog <http://keepachangelog.com/en/1.0.0/>`__ and
`markdownlint <https://github.com/DavidAnson/markdownlint>`__. This CLI
application currently supports GitHub and GitLab.

Install
-------

.. code:: cmd

    pip install release-exporter

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

.. code:: cmd

    python setup.py install

Usage
-----

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

.. code:: cmd

    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

.. code:: cmd

    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:

.. code:: cmd

    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 <http://keepachangelog.com/en/1.0.0/>`__ and this project
adheres to `Semantic Versioning <http://semver.org/spec/v2.0.0.html>`__.

`Unreleased <https://github.com/akshaybabloo/release-exporter/compare/1.0.2...HEAD>`__
--------------------------------------------------------------------------------------

`1.0.2 <https://github.com/akshaybabloo/release-exporter/compare/v1.0.1...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 <https://github.com/akshaybabloo/release-exporter/compare/v1.0...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.


