File: README.md

package info (click to toggle)
cligh 0.3-3
  • links: PTS, VCS
  • area: main
  • in suites: bullseye, buster, sid
  • size: 232 kB
  • sloc: python: 491; makefile: 5
file content (63 lines) | stat: -rw-r--r-- 2,147 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
# cligh - Command-line Interface to GitHub

This is a simple command-line interface to the facilities of GitHub.
It is written by Christopher Brannon <chris@the-brannons.com>.
The current version is 0.3,
released July 23, 2016.
This program is still in the early stage of development.
It is by no means feature-complete.
A friend and I consider it useful, but others may not.

## Obtaining

Obtain the current stable version using this link:
<http://the-brannons.com/software/cligh-0.3.tar.gz>.
You can verify the integrity of the file using the
[gpg signature](http://the-brannons.com/software/cligh-0.3.tar.gz.sig).

## Installation

This program is written in Python 3.x.
There is no backward compatibility with 2.x, since 3.x is the future.

cligh requires the PyGithub package.
The homepage for PyGithub is
[https://github.com/jacquev6/PyGithub](https://github.com/jacquev6/PyGithub).
It can also be installed using `pip install PyGithub`.

The final dependency is PyXDG.
Get it from
[http://freedesktop.org/Software/pyxdg](http://freedesktop.org/Software/pyxdg),
or install it using `pip install pyxdg`.

Once the dependencies are installed,
 type `./setup.py install` in the cligh source directory, in order to install
the script and its helper modules.

## Setup

Run the following command to configure cligh:

    cligh configure

The program will prompt you for a username and password.  It then creates
an authorization using the Github API.
cligh never stores your password.  Instead, it stores the token associated
with the authorization that it created.
It uses this token to authenticate to Github.

## Usage

Usage is straightforward, and the program provides informative help
messages.  Simply type `cligh -h` at a shell prompt,
to see the introductory help message.

## Development

The source for this project is managed by git.  If you wish to contribute,
or if you simply wish to use the unpublished "development" sources, clone
it using a command such as the following:

    git clone git://github.com/CMB/cligh.git

Patches are most appreciated.  Please send them to [chris@the-brannons.com](mailto:chris@the-brannons.com).