gease

================================================================================ gease - gITHUB RELease

.. image:: https://api.travis-ci.org/moremoban/gease.svg :target: http://travis-ci.org/moremoban/gease

.. image:: https://codecov.io/github/moremoban/gease/coverage.png :target: https://codecov.io/github/moremoban/gease .. image:: https://badge.fury.io/py/gease.svg :target: https://pypi.org/project/gease

.. image:: https://pepy.tech/badge/gease/month :target: https://pepy.tech/project/gease/month

.. image:: https://img.shields.io/github/stars/moremoban/gease.svg?style=social&maxAge=3600&label=Star :target: https://github.com/moremoban/gease/stargazers

.. image:: https://img.shields.io/static/v1?label=continuous%20templating&message=%E6%A8%A1%E7%89%88%E6%9B%B4%E6%96%B0&color=blue&style=flat-square :target: https://moban.readthedocs.io/en/latest/#at-scale-continous-templating-for-open-source-projects

.. image:: https://img.shields.io/static/v1?label=coding%20style&message=black&color=black&style=flat-square :target: https://github.com/psf/black

It's understood that you may use github cli, however gease simply makes a git release using github api v3.

.. image:: https://github.com/moremoban/gease/raw/master/images/cli.png :width: 600px

Installation

You can install gease via pip:

.. code-block:: bash

$ pip install gease

or clone it and install it:

.. code-block:: bash

$ git clone https://github.com/moremoban/gease.git
$ cd gease
$ python setup.py install

Setup and Configuration

First, please create personal access token for yourself on github <https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/>_.

.. image:: https://github.com/moremoban/gease/raw/master/images/generate_token.png

Next, please create a gease file(.gease) in your home directory and place the token inside it. Gease file is a simple json file. Here is an example::

{"user":"chfw","personal_access_token":"AAFDAFASDFADFADFADFADFADF"}

Organisation

In order to make a release for your organisation, "read:org" right is required:

.. image:: https://user-images.githubusercontent.com/4280312/33229231-0220f60e-d1c3-11e7-8c95-3e1207415929.png

Command Line

::

gease simply makes a git release using github api v3. version 0.0.1

Usage: gs repo tag [release message]

where:

  release message is optional. It could be a quoted string or space separate
  string

Examples:

  gs gease v0.0.1 first great release
  gs gease v0.0.2 "second great release"

:: contributors list the contributors of a repo. version 0.0.4

Usage: contributors user/org repo

Where: user/org is the your github username or orgnisation name repo is the repository name

Examples:

contributors pyexcel pyexcel-io

License

MIT

Change log

0.0.11 - 18.10.2020

Updated

#. #14 <https://github.com/moremoban/gease/issues/14>_: failed to use public apis

0.0.10 - 18.10.2020

Updated

#. #3 <https://github.com/moremoban/gease/issues/3>_: include license, tests and docs in the package

0.0.9 - 17.10.2020

Updated

#. return all user details using github token if exist. otherwise use public api under quota

0.0.8 - 21.09.2020

Updated

#. return all user details per github user api #. handle 403 and throw out unknown status code

0.0.7 - 28.08.2020

Updated

#. raise UrlNotFound when request a non-existent url

0.0.6 - 26.08.2020

Updated

#. #1 <https://github.com/moremoban/gease/issues/1>_: access repo contributors without github token.

0.0.5 - 21.08.2020

Added

#. use login name if full name of the contributor is null

0.0.4 - 21.08.2020

Added

#. get contributors of a github repo

0.0.3 - 25.11.2017

Added

#. #1 <https://github.com/moremoban/gease/issues/1>_: release repos of the organisation that you belong to.

0.0.2 - 15.10.2017

Added

#. quit with -1 if github responds with error

0.0.1 - 13.10.2017

Added

#. First release.