An open API service indexing awesome lists of open source software.

https://github.com/kenjyco/beu

Beginner Express .:. Back End .:. Big Example .:. Brainstorm Effectively
https://github.com/kenjyco/beu

cli kenjyco python shell

Last synced: 5 months ago
JSON representation

Beginner Express .:. Back End .:. Big Example .:. Brainstorm Effectively

Awesome Lists containing this project

README

          

## About

The `beu` package is intended to be an easy way to explore several complementary
Python packages.

- There is a script to help you get all the system requirements installed
- The `beu` module auto-imports several relevant modules as their preferred
2-character (or 3-character) shortcuts for quick interaction
- The `beu-ipython` command is a shortcut to start an `ipython` session with the
`beu` module imported before you see the shell prompt
- The commands provided by the other packages are all installed to the same
place
- All the advanced features of the packages are made available (since some
packages will do more when certain other packages can be imported)

See the following docs:

-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-

## Install

Install system requirements and install `beu` package to `~/.beu` (Debian-based
distros and Mac). Also modify one of `~/.zshrc`, `~/.bashrc`, or
`~/.bash_profile`.

```
% curl -o- https://raw.githubusercontent.com/kenjyco/beu/master/install.sh | bash
```

Source the `wrappers.sh` file

```
% source ~/.beu/wrappers.sh
```

#### Mac Note

VLC related things (vlc-helper package, system dbus, etc) are not installed
since VLC cannot be controlled with dbus on mac

#### Linux Cloud Note

VLC related things (vlc-helper package, system dbus, etc) and MOC related things
(mocp & mocp-cli packages, system moc) are not installed since you can't watch
videos or listen to audio.

## Usage

The `beu-ipython` script is provided (with the `b` shortcut set in
`~/.beu/wrappers.sh`)

```
% b --help
Usage: beu-ipython [OPTIONS]

Start ipython with `beu` and `pprint` imported

Options:
--no-vi Do not use vi editing mode
--no-colors Do not use colors / syntax highlighting
--help Show this message and exit.
```

```
% b
Python 3.6.8 (default, Jan 14 2019, 17:05:23)
Type "copyright", "credits" or "license" for more information.

IPython 7.6.0 -- An enhanced Interactive Python. Type '?' for help.

In [1]: beu.ih
Out[1]:

In [2]: beu.bh
Out[2]:

In [3]: beu.rh
Out[3]:

In [4]: beu.chloop
Out[4]:

In [5]: beu.ph
Out[5]:

In [6]: beu.yh
Out[6]:

In [7]: beu.fh
Out[7]:

In [8]: beu.dh
Out[8]:

In [9]: beu.sh
Out[9]:

In [10]: beu.ah
Out[10]:

In [11]: beu.jh
Out[11]:

In [12]: beu.ewm
Out[12]:

In [13]: beu.mh
Out[13]:

In [14]: beu.sqh
Out[14]:

In [15]: beu.moc
Out[15]:

In [16]: beu.mocp_cli
Out[16]:

In [17]: beu.vh
Out[17]:

In [18]: beu.wh
Out[18]:

In [19]: beu.th
Out[19]:

In [20]: beu.rmh
Out[20]:
```

## Updating

Use `beu-update` to get the latest changes

```
% beu-update
```

## Misc

You should be able to pass the `--help` option to any of the command/shortcuts
listed below for more info.

- Use `m` (`mocplayer`) to start the REPL to control audio playback and making
annotations
- Use `rh-shell` to explore Collection objects

> Note: see the [wrappers.sh](https://raw.githubusercontent.com/kenjyco/beu/master/wrappers.sh)
> file to see all defined shortcuts.