ceg

Introduction

Ceg (as in create gist and pronounced Keg) is a command-line utility as well as a library for interacting with github gists.it uses github's official api for performing all operations.it can:

Create gists.
Modify existing gists.
Download gists.
List public/private(secret) gists for authenticated users as well as list public gists for unauthenticated users.
Delete a gist.
Create local backup of all the gists.

Installation

There are multiple ways to install ceg,the simplest one being installing from PYPI:

# py instead of python3 on windows
python3 -m pip install ceg

You can also install it manually.for that you need to have poetry installed and be on a system with minimal python version being 3.7.after installing poetry,you can just do poetry build and pip install from dist/ceg*.whl or whatever you prefer.please be mindful that installing poetry from pip is not recommended.

# you can also use install/uninstall scripts after cloning the repo, if on *nix.
curl -sSL https://install.python-poetry.org | python3 - 
git clone https://github.com/justaus3r/ceg.git 
cd ceg 
poetry build

Now wat?

After installing ceg you can either do ceg --help in your terminal, check out projects README or refer to api documentation.

Note: Please only refer to submodule named api as other files contain reference to main implementation of ceg and such may contain ambiguous documentation which may or maynot be clear unless codebase is understood.

View Source

 1# ╔═══╗
 2# ║╔═╗║
 3# ║║ ╚╝╔══╗╔══╗
 4# ║║ ╔╗║╔╗║║╔╗║
 5# ║╚═╝║║║═╣║╚╝║
 6# ╚═══╝╚══╝╚═╗║
 7#          ╔═╝║
 8#          ╚══╝
 9# ©Justaus3r 2022
10# This file is part of "Ceg",a gist crud utility.
11# Distributed under GPLV3
12#    This program is free software: you can redistribute it and/or modify
13#    it under the terms of the GNU General Public License as published by
14#    the Free Software Foundation, either version 3 of the License, or
15#    (at your option) any later version.
16#    This program is distributed in the hope that it will be useful,
17#    but WITHOUT ANY WARRANTY; without even the implied warranty of
18#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
19#    GNU General Public License for more details.
20#
21#    You should have received a copy of the GNU General Public License
22#    along with this program.  If not, see <http://www.gnu.org/licenses/>.
23"""
24Introduction
25========
26Ceg (as in **c**r**e**ate **g**ist and pronounced *Keg*) is a command-line utility as well as a library for 
27interacting with github gists.it uses github's official api for performing all operations.it can:
28- Create gists.
29- Modify existing gists.
30- Download gists.
31- List public/private(secret) gists for authenticated users as well as list public gists for unauthenticated users.
32- Delete a gist.
33- Create local backup of all the gists.
34
35Installation
36============
37There are multiple ways to install ceg,the simplest one being installing from PYPI:
38```
39# py instead of python3 on windows
40python3 -m pip install ceg
41```
42You can also install it manually.for that you need to have [``poetry``](https://python-poetry.org/docs/master/#installing-with-the-official-installer) installed and be on a system with minimal python version being 3.7.after installing poetry,you can just 
43do `poetry build` and pip install from `dist/ceg*.whl` or whatever you prefer.please be mindful that installing poetry
44from pip is [not recommended](https://python-poetry.org/docs/#alternative-installation-methods-not-recommended).
45```
46# you can also use install/uninstall scripts after cloning the repo, if on *nix.
47curl -sSL https://install.python-poetry.org | python3 - 
48git clone https://github.com/justaus3r/ceg.git 
49cd ceg 
50poetry build
51```
52
53Now wat?
54=======
55After installing ceg you can either do ``ceg --help`` in your terminal, check out projects README or refer to api documentation.
56
57**Note:**
58Please only refer to submodule named `api` as other files contain reference to main implementation of ceg and such
59may contain ambiguous documentation which may or maynot be clear unless codebase is understood.
60
61"""
62
63from .misc import UtilInfo
64from .api import CegApi
65
66
67__author__ = "Justaus3r"
68__email__ = "x-neron@pm.me"
69__version__ = UtilInfo.VERSION
70__description__ = UtilInfo.DESCRIPTION