charidotella 0.6

Charidotella is a toolbox to organise and visualise Event Stream (.es) recordings

Charidotella (https://en.wikipedia.org/wiki/Charidotella_sexpunctata) is a toolbox to organise and visualise Event Stream (.es) recordings.

• Dependencies
• Get started
• Contribute

Dependencies

• Debian / Ubuntu

  sudo apt install ffmpeg
  

• macOS

  1. Install Homebrew (https://brew.sh)
  2. Run in a terminal

     brew install ffmpeg
     

• Windows

  1. Install Chocolatey (https://chocolatey.org/)
  2. Open Powershell as administrator and run

     choco install -y ffmpeg
     

Get started

1. Install the Python package

   python3 -m pip install charidotella
   

2. Create a directory my-wonderful-project with the following structure (the file names do not matter as long as their extension is .es)

   my-wonderful-project
   └── recordings
       ├── file_1.es
       ├── file_2.es
       ├── ...
       └── file_n.es
   

3. Generate a configuration file

   cd my-wonderful-project
   charidotella configure ./recordings
   

   The directory now has the following structure

   my-wonderful-project
   ├── recordings
   │   ├── file_1.es
   │   ├── file_2.es
   │   ├── ...
   │   └── file_n.es
   └── charidotella-configuration.toml
   

4. (Optional) Edit charidotella-coniguration.toml to change the jobs' parameters

5. Run the jobs

   charidotella run
   

   The directory now has the following structure

   my-wonderful-project
   ├── recordings
   │   ├── file_1.es
   │   ├── file_2.es
   │   ├── ...
   │   └── file_n.es
   ├── renders
   │   ├── adjective-animal-1
   │   │    ├── filtered-recording.es
   │   │    ├── rendered-file-1.es
   │   │    ├── ...
   │   │    └── rendered-file-m.es
   │   ├── adjective-animal-2
   │   ├── ...
   │   └── adjective-animal-n
   └── charidotella-configuration.toml
   

6. (Optional) Edit charidotella-coniguration.toml and run charidotella run again (job that have already been completed will be skipped unless --force is used)

See charidotella --help for a list of other options.

Contribute

After code edits, run the formatters and linters.

isort .; black .; pyright .