Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/bubobubobubobubo/sonic_pipe

Pipe code from command line to Sonic Pi 4.0
https://github.com/bubobubobubobubo/sonic_pipe

Last synced: about 2 months ago
JSON representation

Pipe code from command line to Sonic Pi 4.0

Awesome Lists containing this project

README 

        
# Sonic Pipe (Sonic Pi from the command-line)



![screenshot](docs/sonic_pipe_screenshot.png)



**This program is highly unstable/experimental. Use with caution, feel free to jump in and help :). I built it one or two years ago and never touched it again.**



I couldn't wait for a new version of [sonic-pi-cli](https://github.com/Widdershin/sonic-pi-cli) or [sonic-pi-tool](https://github.com/lpil/sonic-pi-tool) following the release of Sonic Pi 4.0 so I quickly hacked a CLI tool that allows strings to be piped from the command line to the Sonic Pi Server. The script is a proof of concept based on information gathered from the [Sonic Pi Forum](https://in-thread.sonic-pi.net/). Feel free to change anything and to push changes to the repo :). I don't pretend to replace or do better than the tools mentioned above. Use them if you can once they will be updated!



Sonic Pipe is a project aiming to propose an alternative to the official Sonic Pi GUI. It targets advanced users that are already familiar with the usage of the terminal and/or who prefer to use the command line. Alternatively, it can also be interesting for people willing to play with Sonic Pi directly from Python. 



## TODO list



* Control logs verbosity (less printing).

* Restore Ableton Link functionality (??).

* connect with a custom vim/neovim plugin.



## Usage



* Install the tool using the `setup.py` file.

  1. `git clone https://github.com/Bubobubobubobubo/sonic_pipe`

  2. `cd sonic_pipe`

  3. `pip install -e .` or `pip3 install -e .` depending on your Python installation.



Required dependencies will be automatically installed. A CLI tool will be added to your path: `sonic-pipe`. In forward versions, you will also be able to import SonicPipe as a library for usage in your own Python programs. The rest of the installation process is dependent on the OS you are using. Please refer to the corresponding section.



### Windows



Currently not tested and unsupported. However, this should work already! Please let me know if it doesn't!



### Linux



Please locate the `daemon.rb` file that comes installed with Sonic Pi. This file should be located in the `/server/bin` folder) not far from the actual `sonic-pi` binary. The path to `daemon.rb` can be given to `sonic-pipe` using the `--daemon_path` flag when executing the CLI.



### MacOS



`sonic-pipe` should work out of the box without additional configuration.



### Connecting to sonic-pipe using Neovim



In order to use Sonic Pipe, you will need a tool able to pipe commands from a terminal buffer to another terminal buffer. I recommend using Vim/Neovim [Slime plugin](https://github.com/jpalardy/vim-slime). Very easy to setup and straightforward to use. If you are using [vim.plug](https://github.com/junegunn/vim-plug), you can add the `slime` plugin like so:



```vimscript

call plug#begin()

Plug 'jpalardy/vim-slime'

call plug#end()

```



For convenience, please also add the following line to your `init.vim` or `.vimrc` file:

```vimscript

let g:slime_target = 'neovim'

```



You are now good to go. Follow this quick tutorial to start your first Sonic Pipe session:

1) start `neovim` and split the screen in two separate buffers (`:vs` or `:sp`).

2) in one of the buffers, type `:terminal` to open a new embedded terminal.

3) start Sonic Pipe: `sonic-pipe --daemon=True --repl=True`.



## Commands



Some basic commands are available:



* **stop** : stop currently running code.

* **exit** : exit the REPL/CLI tool.

* **help** : display help files.



Sonic Pipe includes an auto-save tool for your Sonic Pipe sessions. Sessions will be automatically saved whatever happens as `.rb` files located at `$HOME/.sonic-pi/sonic-pipe-sessions/`. Files are named in accordance with the current local time of your computer for easy retrieval.



* **history** : print current session history.

* **purge-history** : delete all files from history.

* **save-history** : save the current Sonic Pipe session.



## Help System



Sonic Pipe includes an embedded documentation system that you can invoke directly from your playing buffer. Some help files are installed by default with the package. Your own help files can be added to SonicPipe by placing them in the `$HOME/.sonic-pi/sonic-pipe-help/` folder in the MarkDown format. This

functionality is helpful to add custom documentation to your own libraries or to save code snippets that you wish to retrieve quickly.



* **help** : display the list of available help files.

* **help [name]** : print the selected help file.