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.0.0-cp312-cp312-win_amd64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | fe831887e50972ac2bc7cc81a28ba5ad42791ef2bac0f6912ddabeaef320f3b2 |
|
MD5 | d699c0236537d134f6f5f85631cdb874 |
|
BLAKE2b-256 | ce9323a848dca2802b1a569d6805cf6a72614172c7a578edbf15f6120f889485 |
Hashes for charidotella-3.0.0-cp312-cp312-win32.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | dd51b291c9cbfe6b318715791f4b884abcdf192dee50db8f9ca67f8be2b7bd9e |
|
MD5 | 4ecbe54a4ddd69085c4e0025c9f01e84 |
|
BLAKE2b-256 | 167eb954dab48a4a624568d2c6da641c7f0aaf0405ffba6b4fadb5b08260781b |
Hashes for charidotella-3.0.0-cp312-cp312-musllinux_1_1_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 25b9e35055fe6b18531700a228097d94fcbe8913da97d7471f8b026cdb4aab47 |
|
MD5 | b9a61c07a42e7251b2ac9439e46499db |
|
BLAKE2b-256 | ffc75445653887acc1dc4fc858eb6dfb0a6b8b379b79eee98bb2eff67ece5e9f |
Hashes for charidotella-3.0.0-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7ba2c4e701c73fc706e402ae66108011cddd2e7fe72c43226a0a026053ff27d6 |
|
MD5 | c19fa63e8b597f5363b1fa48065f2f78 |
|
BLAKE2b-256 | 592f7aa915e0fd0d9508b9f9a2671e2a5ea932f1df2770915f985a06d12a59ba |
Hashes for charidotella-3.0.0-cp312-cp312-macosx_11_0_arm64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7f0ef7ecea46fd36a2974d94ebd3585fc9ceaf353e513d2e832b56388d59e97f |
|
MD5 | 34001109e76bf483287185066c2a4178 |
|
BLAKE2b-256 | dd541ed0fc8abbc8ce1acc7819e8f2eb6382ab344d1542ed813ba40aa5ff9b9c |
Hashes for charidotella-3.0.0-cp312-cp312-macosx_10_9_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 424bba7a0d80575f7ad1db4f3585b1ec2d49f08ead9794f9cb0eaca6021f2eac |
|
MD5 | 3415173f6f4a3c40c4037cda06f0976b |
|
BLAKE2b-256 | 5efccd13001717cc6ebb267e548350a563c2f4357e6afcece6ad45e23eef4786 |
Hashes for charidotella-3.0.0-cp311-cp311-win_amd64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 969144dbf65ecef2aa483111eea1dd27d8214219f04f1219419cad2ce01cbf86 |
|
MD5 | 05014947158b103ceb6066bccb16836f |
|
BLAKE2b-256 | 6d115b552f397f48638a461e2c53b5270b586cec80f0b80c1e8f7c2174774f37 |
Hashes for charidotella-3.0.0-cp311-cp311-win32.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4d554ce56aea170e483707b1ff75a7159a95cd479c9b6aa90811ccdbd291763a |
|
MD5 | b98b7c5e4ad7412a20afbcf35b3df5ff |
|
BLAKE2b-256 | 37800982bafb5ab058bbc429b42a7fe1fc4e17cbba6c1ba38e4ccafdd6448dcc |
Hashes for charidotella-3.0.0-cp311-cp311-musllinux_1_1_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e0cc612bff1fa93b313c72e533016f57b979555228d88e132547c6dd496fdf43 |
|
MD5 | 640bbd9ccee6dfc87ef5b08c50b1b5de |
|
BLAKE2b-256 | f0f239dd7bb5069ffd0aaf36ff0315765395a5fb458c0a1508daf7b78f10af22 |
Hashes for charidotella-3.0.0-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e7cbbec2855b0df9e527ef375b16067117416a69d7bbf76e9bfc67f864b901f2 |
|
MD5 | 3ad51179e43c6ff07405a378f01e15e3 |
|
BLAKE2b-256 | 8a096757c7df397211f3b8d9c9ef00142551b1e578338d772f6ce69cdf58cc28 |
Hashes for charidotella-3.0.0-cp311-cp311-macosx_11_0_arm64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1206bcabb5677fc15dc7bc97b4b5e85f5e3534d37fd62789b1d714e41ae98014 |
|
MD5 | ab266b3ab516ee84c5a00ea8b3c22960 |
|
BLAKE2b-256 | 1fc8c7c57153b071ccba93e2507745edbf2cb868dc17c466ba26f6e2f612bf2c |
Hashes for charidotella-3.0.0-cp311-cp311-macosx_10_9_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4c621571a20d8bcc24de43d3f5bed4bdfd904eeda395eb273f0667ce1c3fee29 |
|
MD5 | adbdd0e536c29937b12d3a99b3e1a015 |
|
BLAKE2b-256 | e772fe2f51435220a6eeb01acbe72365d719c7955d1b83bab882ada434bfe50a |
Hashes for charidotella-3.0.0-cp310-cp310-win_amd64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 640a8c06c68e05070d4d767c364f4f0ac0609c2d4b34345bc37259e4578fb522 |
|
MD5 | 9d01da048420f7bb21e1bcb37cdcd1cc |
|
BLAKE2b-256 | da9bb2dc5fc7fbf086b7699e24a2ed3d5694d67338bac0f70f7d4569943da234 |
Hashes for charidotella-3.0.0-cp310-cp310-win32.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1d41fded81ba3413391e128911bb79b01dd0ac2f07cfb7c2bb4e6754ed8b0756 |
|
MD5 | 0b90fffbf391982c5c5949dc136fa7c7 |
|
BLAKE2b-256 | 4e6e1fb94a3210779c732c29d8bc627c701d21a6f7f87f5fce8e0c47c9c33f9f |
Hashes for charidotella-3.0.0-cp310-cp310-musllinux_1_1_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0b3c6d8e5dd08830c8b94dd3efd347269704f3e0791336110db874e2b8514eff |
|
MD5 | e68e8a8832d6983ab97ecd7b483a1e16 |
|
BLAKE2b-256 | fb9ac4a8f92898707d36420c29c845ff72d4e69f232514e73fcbae9e7421ca6b |
Hashes for charidotella-3.0.0-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f23a0e26f710e59e38848945e43c69210a26d3acb33dc09bcbc956bfd071b690 |
|
MD5 | 688cd32a84de83d0a541e3e491c67fc3 |
|
BLAKE2b-256 | 9fb321c7a02ffa60f3f82f777f37450e45f6c5d4975591746273eaf123e1cd36 |
Hashes for charidotella-3.0.0-cp310-cp310-macosx_11_0_arm64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8d7e46194a998fc6ec5032786e480aa5796a15c0649a2d2c88025e21623e7e0e |
|
MD5 | 679e82944030cbeb37aa4e83eda76843 |
|
BLAKE2b-256 | ae0747a4a08d4cad723368618992a98a5facfbc2c9fffb34a0bf6cb930417afe |
Hashes for charidotella-3.0.0-cp310-cp310-macosx_10_9_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e0478119a4e90e730de038681bb1808f0a52e8fa2638c9e8e982dd67f3f99728 |
|
MD5 | ce21922f3c3e8dbc3e5b4b53a005bc40 |
|
BLAKE2b-256 | a9332188470191d36f1c0e7375072c4671fce86593ac368e48ef227b3a7b896c |
Hashes for charidotella-3.0.0-cp39-cp39-win_amd64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | dbef7392d9b7a2d514ce06bdec2592d333117bb5d9d90bbc68c0621040925351 |
|
MD5 | c4b1e24449189ee1fdbeee10bdca6cb8 |
|
BLAKE2b-256 | a84a8d238cab090a4300718fbf136d728c60a8c4ba94cf488cf357115643c417 |
Hashes for charidotella-3.0.0-cp39-cp39-win32.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5ddcde29bd09c4febe44498b6b546fb2f839aa0e44b5543932fd80669b0b4cba |
|
MD5 | aec42ee0cee2088e9410c4d733312e65 |
|
BLAKE2b-256 | 16c39f3d41f4733df7135eb1c8ab160c6ca0401adbd80ec4c5de184bad8cb67b |
Hashes for charidotella-3.0.0-cp39-cp39-musllinux_1_1_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5d86d68eb04f7154d8060b747bd0450c649d628bcdd599d4ea6122b772f098d1 |
|
MD5 | f0e8d75c1fe53d83850e274cb15be5d0 |
|
BLAKE2b-256 | 99e1f8feba0533a44ef88a40a54f624d11155049b92a2ee42923bad4f54c03c3 |
Hashes for charidotella-3.0.0-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 57212d85de810a97da26ad23c6806fb3849501146a28d704132f099b613d1018 |
|
MD5 | d036a04cfd9583ebedc993cda1b09ca0 |
|
BLAKE2b-256 | aae4276ad2576ac1c15b1a78c9f12382d35781df76225f466898c3adc9cb47f6 |
Hashes for charidotella-3.0.0-cp39-cp39-macosx_11_0_arm64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7943e9ac377e5c60b8b55b4f07d3779179779cdc0e10fc0f37dd4e8c5ba20eb5 |
|
MD5 | f9de509d41ff6c0e49ed7a65521cb9d1 |
|
BLAKE2b-256 | 4e99616a8f80325e2a899888fb3bc1c34de56dad6fb65917ed1cb12833f0c3b6 |
Hashes for charidotella-3.0.0-cp39-cp39-macosx_10_9_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e5b76aff41197e7f41fcbe606b4273e0f257de22d4d47e240c0b4eb84c6783d2 |
|
MD5 | 295cc72f04abd8607d995c7134959936 |
|
BLAKE2b-256 | 9c9693b24bb6607f56eb50ac8264cc1f49d926b1e994e1c014a68518dcdcf927 |
Hashes for charidotella-3.0.0-cp38-cp38-win_amd64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | cb4da38f0937d591c5789593093237cf301f6afa12026f348fe2a5f11d024cab |
|
MD5 | 2f6d5f3b7c8ebc8db184a6dbe4810c54 |
|
BLAKE2b-256 | 876b5add94b5f93d134b44b50f71335325e5fa7583f9a0833960d5ef34567540 |
Hashes for charidotella-3.0.0-cp38-cp38-win32.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 864ab7a227b4c5d881b50158278a3a5a6f1c6840a9def590a8a96e959b81376b |
|
MD5 | 97cf87d0c8e6fc945adbcc1721f73b4a |
|
BLAKE2b-256 | 38a0c06012b98faa964ea4901cb82bbfec0d02caf7affba0735afeacf0ac6a9a |
Hashes for charidotella-3.0.0-cp38-cp38-musllinux_1_1_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 21dd6afe6f18af5f2aee5f2e0b500d5e198ec5447489e1d054bec0cb0a11493b |
|
MD5 | 72c4b7eee78ea3427eefffcf559afa3e |
|
BLAKE2b-256 | 679221434260334bcda58ba9b693238a0b9d412f016fc970a3d1719ef04d3c53 |
Hashes for charidotella-3.0.0-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9458270820dd3bc713dbc689371e9c22e8139ba114c7362c944edd3c21569165 |
|
MD5 | 5acd5aa714d3af4e2507afe7eda4231a |
|
BLAKE2b-256 | 8471c55f484a0c96ff4bc2f0cc3d098bdccc9ec913bdd39d47c2f980bfab7b24 |
Hashes for charidotella-3.0.0-cp38-cp38-macosx_11_0_arm64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1eb5c574f57c820a96b72d13fa0b1c3e88d779ccf1b5d6d1a7910c5d127cc91b |
|
MD5 | 0fd497d07fe0d487b2a4ba83c4169320 |
|
BLAKE2b-256 | 3b7b0d7c2b81ae80bd25cb5e9c2c4e5e59e98549f3ff8c66610d02dfe0846fc1 |
Hashes for charidotella-3.0.0-cp38-cp38-macosx_10_9_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 23e81ab58de5ab88ea97ed358977529e3e7569a7e13ccea69ad6d5ea1b1c7ce8 |
|
MD5 | d2288c0976ad54d3c57c0fb222d34f32 |
|
BLAKE2b-256 | 78f1f423382c7eb24730386f341118e3fdb23d72d321b7bdd0f8121c2214426f |