semvec/pypi-packages huggingface dataset:
ingi-cli 0.1.1
A CLI tool for gists like no other. Run, download and help build a searchable gist API

# ingi-cli
A CLI tool for gists like no other. Run, download and help build a searchable gist API


[![Build Status](https://api.travis-ci.com/ianloubser/ingi-cli.svg?branch=master)](https://travis-ci.com/ianloubser/ingi-cli)
![Python version](https://img.shields.io/badge/python-3.6-blue.svg)
[![Coverage Status](https://coveralls.io/repos/github/ianloubser/ingi-cli/badge.svg?branch=master)](https://coveralls.io/github/ianloubser/ingi-cli?branch=master)

## Features
- Run gists directly from your bash. Multiple language support (python, ruby, shell, node)
- Offline cache for gists


## Installation
**ingi** assumes that any required binaries for executing gists are installed on your system, if not then it will fail.

Install the cli tool through pip:
```
pip install ingi-cli
```

## Usage

Invoking a gist
```
ingi get https://api.github.com/gists/ac5a0fb49370e7cff3bee93ecc40b9a8
```
or use the gist ID
```
ingi get --use_id ac5a0fb49370e7cff3bee93ecc40b9a8
```

You can also just cache the gist to use later
```
ingi get --save_only --use_id ac5a0fb49370e7cff3bee93ecc40b9a8
```

## TODO & Improvements
- Implementing a gist index to search gists programmatically. Any gists executed locally get automatically inserted and indexed on API to be used. 
This will provide us with a rest API to search for gists &#x1F600;.

- Configurable invoke queue, like an `invoke.yaml` which lists a bunch of gists to execute in order.

- arguments to be passed to scripts, for e.g:
```
ingi get --use_id ac5a0fb49370e7cff3bee93ecc40b9a8 first_arg second_arg
```
gf-kernel 1.0.0
Simple example kernel for GF

GF Kernel
===========

`gf_kernel` is a [GF](https://www.grammaticalframework.org/) kernel for [Jupyter](https://jupyter.org/).

Prerequisites
-------------
If you haven't installed GF already, get it from the official [download website](https://www.grammaticalframework.org/download/index.html).


For graph visualization GF uses [graphviz](http://www.graphviz.org/), so please make sure you have it installed:

    sudo apt install graphviz

or under Mac OS X with [homebrew](https://brew.sh):

    brew install graphviz

Installation
------------

You can either install the kernel from the source repository: 

    git clone https://github.com/kwarc/gf_kernel
    cd gf_kernel
    pip install .

or install it directly from pip:

    pip install gf-kernel

Afterwards, install the kernel module with:

    python -m gf_kernel.install


Usage
-----
You're now ready to go and can start a Jupyter notebook with:

    jupyter notebook

Select the `gf_kernel` as kernel in your notebook.
The kernel supports all of the GF shell commands.
Output files produced by these commands will be placed into the current directory.

The kernel can also be used to define new grammars, which are immediately imported for usage upon defining.
If you would like to have line numbers for editing your code you can use the Juypter shortcut <kbd>Esc</kbd>+<kbd>L</kbd> to enable them. 

In addition to the GF shell commands the kernel supports the following commands:
- `view` : show the graph(s) generated by the specified GF shell command
- `help` : shows the help message
- `export` : saves the specified grammar in the current diretory
- `clean` : removes all `.dot`, `.png` and `.gfo` files from the current directory

Please refer to the tutorial notebook to see how exactly they are used.

This package requires Python 3.