Charidotella is a toolbox to organise and visualise Event Stream (.es) recordings
Project description
Charidotella (https://en.wikipedia.org/wiki/Charidotella_sexpunctata) is a toolbox to organise and visualise Event Stream (.es) recordings.
It supports Python 3.9, 3.10, and 3.11.
Dependencies
-
Debian / Ubuntu
sudo apt install ffmpeg python3 python3-pip vlc
-
macOS
- Install Homebrew (https://brew.sh)
- Run in a terminal
brew install ffmpeg python3
-
Windows
- Run in an elevated Powershell (right-click > Run as Administrator)
winget install python3 --scope machine winget install ffmpeg --scope machine
- Reboot the machine
- Run in an elevated Powershell (right-click > Run as Administrator)
Get started
-
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 runcharidotella 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 .
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distributions
Hashes for charidotella-3.1.0-cp312-cp312-win_amd64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 89759d2e1a160ac7ab9ce4f80f2fda42589172fda6ccac4df31a378751ebc2e1 |
|
MD5 | 61c85ed269536cc24b9e04876383d106 |
|
BLAKE2b-256 | 32b50b7b4850534f3365ef34acf322ecc556c59a7ca25d1d1bb8e07d10dd6584 |
Hashes for charidotella-3.1.0-cp312-cp312-win32.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a1c73e878f395e8e87139f67ce6136c55a7802347634ad2be9d8d38555155720 |
|
MD5 | 189e34797f4973d65c0d526969826e12 |
|
BLAKE2b-256 | 4a3b13387110c8e2fde7f5d052854d68dea403bf9ca49610fcedeaf2338914a5 |
Hashes for charidotella-3.1.0-cp312-cp312-musllinux_1_1_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c0a9004e5027c971912f7f173e563641f8dbbe50272e0b876d7cfdf9dc9f8ca6 |
|
MD5 | 39b94907fe2e20336947d31671de943f |
|
BLAKE2b-256 | 989e1c4384ead2d30f378a4a49506e064008e4c82f67f637bd9a051c790cde25 |
Hashes for charidotella-3.1.0-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 00ed76d54ed0a2d766b99d77a5e6abb1eaa6a70524af2f49ebe5154d9b0c8bfa |
|
MD5 | 8d0ed3bc697b3a5c283735d3d612d677 |
|
BLAKE2b-256 | 9dbabe2fbd6c841b396eecab03c55ece033b6c842f2601afa781bd75ad869846 |
Hashes for charidotella-3.1.0-cp312-cp312-macosx_11_0_arm64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a9e0f769c68ffc9cfc52763464cae1289bc51a52018d6477f2848114be1b61ca |
|
MD5 | c5cdeab2fed140a62891f9b4cc6d31e3 |
|
BLAKE2b-256 | e773d35694b79dacec25c9ee9824b2684bd8563de6b414e4e1a4a0fbcbb2bde2 |
Hashes for charidotella-3.1.0-cp312-cp312-macosx_10_9_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 766b019841e81560cfac291341c38666008d9ac834b0c1d5b8301e6909b9a1de |
|
MD5 | 778618f4e079db4aed4233c145a8fffc |
|
BLAKE2b-256 | 75d4f8c6110f95f6d5800520a0d582cb5276116dcba4f89e47109fc447058e1b |
Hashes for charidotella-3.1.0-cp311-cp311-win_amd64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e9c16e0388e6d7ee6edc18f9f65af38f5de2f700cf407d89a5ac25c6604af6b5 |
|
MD5 | 3108121415c0db3ba34a61828c07d4b5 |
|
BLAKE2b-256 | 3e8f8a3a599a4e8f82310020ac1f204ba4692ff255e7c00b2b83b098f6f794c0 |
Hashes for charidotella-3.1.0-cp311-cp311-win32.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | bbb514937de83bf28907cbc064e7c46b6771dd378e0c20ebaaf0e45e0163cf65 |
|
MD5 | 72adbd03ecaf4b22341caa0e01187288 |
|
BLAKE2b-256 | ef179b2751ba9410f8e142a5f58f283be08914f1f86ac13a95ab77c8f4a5a8da |
Hashes for charidotella-3.1.0-cp311-cp311-musllinux_1_1_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4c6ae93d86187b91f96ac77f62e9ad701ec229a9af4243b86721bb98b73967a2 |
|
MD5 | b2baeaa2e40f502f7ac5eab4f9ac80e0 |
|
BLAKE2b-256 | 03d0905243c4ee3b613b4048f0434d6adf7e9384962cb60fbf756d9cc8272f41 |
Hashes for charidotella-3.1.0-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3a5f45d70a328fe48b69eec85b3605d7545ec4ebf6b9eb84395e5a07768c2411 |
|
MD5 | aff82923bb5c9bd00dbdd7956db5585f |
|
BLAKE2b-256 | ea9048ca82d365edde10151a1c8ffb6e6942dced2d8489236270c8b48b513227 |
Hashes for charidotella-3.1.0-cp311-cp311-macosx_11_0_arm64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e7b10aa4ff79391494c6583c6b783e0ef28a611218887865b0222403e84d456c |
|
MD5 | 82d0ec87242c19181d63d60c86fe1574 |
|
BLAKE2b-256 | 343fb9be5279bd09d15b224d2d529b46f478b559b9b32b387b6135624afe6145 |
Hashes for charidotella-3.1.0-cp311-cp311-macosx_10_9_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3a7aa327911a50adf275a26fce41be056d870ceba8f28646a4f8c0a815f47e0b |
|
MD5 | aa104fc21c97d74414f8f64dd44970ce |
|
BLAKE2b-256 | 6591ec3de5c1a192091855f450673e15bb425ed9fe2ad769a56c513145580445 |
Hashes for charidotella-3.1.0-cp310-cp310-win_amd64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3e95df2f6d232e1fa99ee06cf995bfd006fda8a15f8e7303ae54c3b67ee46d04 |
|
MD5 | 8383493f5d2a628301cafd7981896b7a |
|
BLAKE2b-256 | 4be07e50a5f933a355150bc5348381f3a1a7c1b7139146f2b49fc086829eda70 |
Hashes for charidotella-3.1.0-cp310-cp310-win32.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7107ae02dfa1927cb4c1cca7418fc03d071a96897494beb9991787c726eaf2b7 |
|
MD5 | e7a380c4aa40e5d45f2f3bec7c8d48d5 |
|
BLAKE2b-256 | 9054f11f7f954409051082650df58815a76a830984304fd73281b34be2227d31 |
Hashes for charidotella-3.1.0-cp310-cp310-musllinux_1_1_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6d379af6b2cb6707815cb57f70a24bfed40569f8c85364a063c65ad7c399f3e2 |
|
MD5 | 9feeaf5e77d19c5131cc34542030e516 |
|
BLAKE2b-256 | 5c362913e39cf568a0a62e286d90367216e43f92edcf421b89796776de757330 |
Hashes for charidotella-3.1.0-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c5b8803475c763bc9937e8b676e4b0d8afd4b4b4b2d7b0d4300537b0599b7f05 |
|
MD5 | b4f3533e5bc2172916a8d64b50dccd26 |
|
BLAKE2b-256 | bbc1d049251f80699a0977d8b67dedeac4cdba28950792155a186abde0f21cf2 |
Hashes for charidotella-3.1.0-cp310-cp310-macosx_11_0_arm64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8d93c4acd74389c91a203657e96312bb21976878cb7bde1be8925a45a1d5ab12 |
|
MD5 | debc5d7dea1849e5acad6d88e2017628 |
|
BLAKE2b-256 | b2833954b5fbda638bd3d01b0b8d214d688c2f8128b13d422265e65cf2175457 |
Hashes for charidotella-3.1.0-cp310-cp310-macosx_10_9_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | d7ad3cca8d364f213f4668bc083e410a5964d2b9a58265d37529581fde0a7b82 |
|
MD5 | 5f96c25717964fa7ffa0f2c195d0d048 |
|
BLAKE2b-256 | 10150010284f273b92e8c4c2759371286689084090cca9a5105b5ce58002ac98 |
Hashes for charidotella-3.1.0-cp39-cp39-win_amd64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3dd570655ddb38f9c747c58d3e2066d375799cf41dc4fd6650b185afdacfb617 |
|
MD5 | 12b5f01a762189ae71d13c371a9b069e |
|
BLAKE2b-256 | 1abc56e0fc5d55da6f0c95c7d19b7a73d579afbc40ebe9c90397d1eec317de7b |
Hashes for charidotella-3.1.0-cp39-cp39-win32.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | fe6348ff09fc567bb1bbf2c65e388a66c541a35865bd57e02ca7180c10ade426 |
|
MD5 | 4588002ff43b07e12d9fa7f1300693ad |
|
BLAKE2b-256 | 0ab89f535189cc5add8d0f455a12f6c8de4443164c467f28ad92de85fd0a6702 |
Hashes for charidotella-3.1.0-cp39-cp39-musllinux_1_1_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | d05adcb804158e9f858a261813923ca189d14cf72a23053f71464d049c5fd0dc |
|
MD5 | e0e9b45489c4e367e3b5dd9d69fc08b1 |
|
BLAKE2b-256 | afa0e16da169b02efd441631d7b76099bb514d1732505fee854dfdf7a4ec0a1d |
Hashes for charidotella-3.1.0-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4cd632390724ee91ee0ee689adaaed4dce05c4dd442a82ff13f6daf74783d605 |
|
MD5 | 4d0c2d5cd01a958c91e911a03adbbf2a |
|
BLAKE2b-256 | 5342690777a2b8f7fdb081f130c0e67a93f476598b657ba6782ab845c2ff906a |
Hashes for charidotella-3.1.0-cp39-cp39-macosx_11_0_arm64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | fa54f542b81411beb37661d493ca20b611bb717badde57a3054f0b42776a0619 |
|
MD5 | 1ba983a1bc1c1ae1f5f57c5088a18f1a |
|
BLAKE2b-256 | a9d5cba61f9ce6ea67f1c999e1f795d214c469979152af3ea3805f6bdc4741e3 |
Hashes for charidotella-3.1.0-cp39-cp39-macosx_10_9_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1a2ab6628b3729cbba0891ce7e20e3801138f8574d66dc4f8596f8593f95f5ab |
|
MD5 | e810b9b4320c79da654df0d311b54279 |
|
BLAKE2b-256 | 006d22ab07414d3fc751977ddaef4c5bd57f3c4fa47069ebd42a4ede2ecc5f1d |
Hashes for charidotella-3.1.0-cp38-cp38-win_amd64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e13a9fa4a78ca2d0ad1fc43c4f7650b70d0deecc2ee681f3c676562e19b33ac2 |
|
MD5 | 2f8830db513a0a812fdbe33a42f95f39 |
|
BLAKE2b-256 | c029521657ef164fa0e1a61489f05352072163f023f6e62339288884e5da573e |
Hashes for charidotella-3.1.0-cp38-cp38-win32.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 996d249710557185ec081a8687b4e168a71b49d5be18b640fb1764921aefde4d |
|
MD5 | 628ea2f61193490d1f85ad0cc8d81475 |
|
BLAKE2b-256 | cbbb244d7db892c7fdb4a7b146e999cc837e399054c5b13fb0f254191ce091ad |
Hashes for charidotella-3.1.0-cp38-cp38-musllinux_1_1_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 505591bc251fa3a0b0ffa246b7cafa40b675d0a7318a6d3ba900d9862f265a09 |
|
MD5 | 4e293e95a27e3e0f337437fc7b50c672 |
|
BLAKE2b-256 | b38d4bf5d3fd6a7f8363fadf435069db978bb7e21f7adafd5b64f0e89fe0d61b |
Hashes for charidotella-3.1.0-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ba5b0c7f1968ce77f7412b8b3b3ca695612db135ad0472eacfc75929beb9c302 |
|
MD5 | 325a168342dd4b28ec092ab8c393ac85 |
|
BLAKE2b-256 | c804175f90bba08c9d70389b53fd356725334fe25749ec88999b8693023f5d8a |
Hashes for charidotella-3.1.0-cp38-cp38-macosx_11_0_arm64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4de0a359a46977b32fd6fab41dbbc92a2c75ec9a17007ba52578d4a8fa44c16b |
|
MD5 | a935c73de02bd95cd654712256fc0a3d |
|
BLAKE2b-256 | 58b267f5cba014da4d14fa95b173811a663ff20b8af2bd433b60db76fafc5de0 |
Hashes for charidotella-3.1.0-cp38-cp38-macosx_10_9_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ed21a759b6b6a6ee5a78b508fbe4c82b58aef231c7dab991d27ee70d42771794 |
|
MD5 | e75fe80603d5fd20efc548ca35e3d505 |
|
BLAKE2b-256 | b7eccbf614de6a891f76be89b9af80d8e9a10c1a1858f98d31b314e37b7ea5f6 |