It supports Python 3.9, 3.10, and 3.11.
-
Install the Python package (system-wide or in a virtual environment)
a. System-wide installation
- **Debian / Ubuntu**
```sh
sudo python3 -m pip install charidotella
```
- **macOS**
```sh
python3 -m pip install charidotella
```
- **Windows**
Run in an elevated Powershell (right-click > Run as Administrator)
```powershell
& 'C:\Program Files\Python311\python.exe' -m pip install charidotella
```
b. Installation in a virtual environment
- **Debian / Ubuntu**
```sh
python3 -m venv charidotella_venv
source charidotella_venv/bin/activate
pip install charidotella
```
- **macOS**
```sh
python3 -m venv charidotella_venv
source charidotella_venv/bin/activate
pip install charidotella
```
- **Windows**
Run in an elevated Powershell (right-click > Run as Administrator)
```powershell
& 'C:\Program Files\Python311\python.exe' -m venv charidotella_venv
charidotella_venv\Scripts\Activate.ps1
pip install charidotella
```
-
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
-
Generate a configuration file
cd my-wonderful-project
charidotella init
The directory now has the following structure
my-wonderful-project
├── recordings
│ ├── file_1.es
│ ├── file_2.es
│ ├── ...
│ └── file_n.es
└── charidotella-configuration.toml
-
(Optional) Edit charidotella-configuration.toml
to change the jobs' parameters
-
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
│ ├── file_1
│ │ ├── filtered-recording.es
│ │ ├── rendered-file-1.es
│ │ ├── ...
│ │ └── rendered-file-m.es
│ ├── file_2
│ ├── ...
│ └── file_n
└── charidotella-configuration.toml
-
(Optional) Edit charidotella-configuration.toml
and run charidotella run
again (job that have already been completed will be skipped unless --force
is used)
After code edits, run the formatters and linters.