Skip to content

Commit

Permalink
docs
Browse files Browse the repository at this point in the history
  • Loading branch information
wsanchez committed Nov 6, 2023
1 parent 831ea12 commit 4e1d9a3
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 6 deletions.
27 changes: 22 additions & 5 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,19 +10,36 @@ Ranger Radio Transmission Indexer

This software package contains functionality for processing audio from Burning Man's radio system.


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

This package uses the `pydub`_ and `openai-whisper`_ Python packages, each of which has specific setup requirements.
To install this package, you will need to install `Python 3.11`_.
You should also install the `pipx`_ tool, which provides an easy way to install python executables.

Additionally, this package uses the `pydub`_ and the `openai-whisper`_ Python packages, each of which has specific setup requirements.
See the instructions for each package for details.
In particular, both require ``ffmpeg``.
In particular, both require `ffmpeg`_.

On macOS using Homebrew, you can use the following command:
On macOS using `Homebrew`_, you can install what you need thusly:

.. code-block:: console
brew install ffmpeg
brew install python@3.11
brew install pipx
brew install ffmpeg
Once you have the above installed, you can install this package using ``pipx``:

.. code-block:: console
pipx install --python=python3.11 git+ssh://git@github.com/burningmantech/ranger-transmissions.git
You should now have a command called ``rtx`` in your system.


.. _Homebrew: https://brew.sh
.. _ffmpeg: https://ffmpeg.org
.. _openai-whisper: https://github.com/openai/whisper
.. _Python 3.11: https://www.python.org/downloads/release/python-3116/
.. _pydub: https://github.com/jiaaro/pydub/
.. _whisper: https://github.com/openai/whisper
2 changes: 1 addition & 1 deletion src/transmissions/run/_store.py
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ def storeFactoryFromConfig(configuration: dict[str, Any]) -> StoreFactory:
def sqliteStoreFactoryFromConfig(storeConfig: dict[str, Any]) -> StoreFactory:
from transmissions.store.sqlite import DataStore

fileName = storeConfig.get("File", "./rtx.toml")
fileName = storeConfig.get("File", "./rtx.sqlite")

async def factory() -> TXDataStore:
store = DataStore(dbPath=Path(fileName))
Expand Down

0 comments on commit 4e1d9a3

Please sign in to comment.