Ecosyste.ms: Awesome

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

https://github.com/sloria/doitlive

Because sometimes you need to do it live
https://github.com/sloria/doitlive

bash cli click command-line hacktoberfest ipython live-coding presentations python script zsh

Last synced: about 1 month ago
JSON representation

Because sometimes you need to do it live

Lists

README

        

========
doitlive
========

.. image:: https://badgen.net/homebrew/v/doitlive
:alt: homebrew badge
:target: https://github.com/Homebrew/homebrew-core/blob/master/Formula/d/doitlive.rb

.. image:: https://github.com/sloria/doitlive/actions/workflows/build-release.yml/badge.svg
:alt: Build Status
:target: https://github.com/sloria/doitlive/actions/workflows/build-release.yml

.. image:: https://badgen.net/pypi/v/doitlive
:alt: pypi badge
:target: https://pypi.org/project/doitlive/

.. image:: https://badgen.net/badge/code%20style/black/000
:target: https://github.com/ambv/black
:alt: Code style: Black

`doitlive` is a tool for live presentations in the terminal. It reads a file of shell commands and replays the commands in a fake terminal session as you type random characters.

.. image:: https://user-images.githubusercontent.com/2379650/31386572-2e2b9d14-ad95-11e7-9be5-fcc5ed09f0e8.gif
:alt: Demo
:target: http://doitlive.readthedocs.io

Get it now
----------

macOS with `Homebrew `_:
*****************************************

.. code-block:: console

$ brew update
$ brew install doitlive

With pip:
*********

.. code-block:: console

$ pip install doitlive

Requires Python >= 3.7 with pip.

Quickstart
----------

1. Create a file called ``session.sh``. Fill it with bash commands.
2. Run ``doitlive play session.sh``.

.. code-block:: console

$ doitlive play session.sh

3. Type like a madman.

More at https://doitlive.readthedocs.io
---------------------------------------

Project Links
-------------

- Docs: https://doitlive.readthedocs.io/
- Changelog: https://doitlive.readthedocs.io/en/latest/changelog.html
- PyPI: https://pypi.python.org/pypi/doitlive
- Issues: https://github.com/sloria/doitlive/issues

Kudos
-----

- Idea came from Jordi Hermoso's `"Revsets" talk `_ at PyCon 2014.
- Armin Ronacher's `click `_ library made this quick to implement.
- Themes inspired by Sorin Ionescu's `prezto `_ zsh themes.
- Hat tip to related projects `HackerTyper `_ and `PlayerPiano `_

License
-------

MIT licensed. See the bundled `LICENSE `_ file for more details.