Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

charidotella

Package Overview
Dependencies
Maintainers
1
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

charidotella

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

  • 3.1.0
  • PyPI
  • Socket score

Maintainers
1

banner

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

    1. Install Homebrew (https://brew.sh)
    2. Run in a terminal
      brew install ffmpeg python3
      
  • Windows

    1. Run in an elevated Powershell (right-click > Run as Administrator)
      winget install python3 --scope machine
      winget install ffmpeg --scope machine
      
    2. Reboot the machine

Get started

  1. 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
        ```
    
  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 init
    

    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-configuration.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
    │   ├── file_1
    │   │    ├── filtered-recording.es
    │   │    ├── rendered-file-1.es
    │   │    ├── ...
    │   │    └── rendered-file-m.es
    │   ├── file_2
    │   ├── ...
    │   └── file_n
    └── charidotella-configuration.toml
    
  6. (Optional) Edit charidotella-configuration.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 .

FAQs


Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc