Skip to main content

Top-level package for skellycam.

Project description

Project Logo

SkellyCam

An easy and efficient way to connect to one or more cameras and record synchronized videos 💀📸

Latest Release AGPLv3+ Contributions Welcome https://img.shields.io/badge/code%20style-black-000000.svg


Motivation

Connecting to cameras on multiple platforms in a way that is not slow is a difficult challenge, especially for new developers.

There are a bunch of tools out there (e.g. OpenCV) and other open source libraries that give just enough to support hardware manipulation, but they need to be use in concert in order to be useful.

This library attempts to string those things together, and provide an interface for everyone to use in python with a simple pip install.

The primary focus is to provide an easy method to connect to one or more cameras and provide methods for streaming/recordig synchronized frames from the connected cameras.

NOTE - The SkellyCam package is the primary camera backend for the freemocap markeless motion capture software 💀✨

https:github.com/freemocap/freemocap

https://freemocap.org


Installation and Usage

0. Open a terminal (ideally with a python virtual environment activate)

1. Install from Pip

Enter the command below and press 'Enter'

pip install skellycam

2. Launch SkellyCam GUI

Enter the command below and press 'Enter'

skellycam

3. Success! 💀📸✨

Hopefully a bunch of text scrolled by and a GUI popped up!

If not, please open an issue on the github repo and we'll try to help you out :)

Limitation (aka TO DO) -

  • Currently uses opencv to connect to cameras, so it won't recognize hardware that can't be connected with cv2.VideoCapture - Support for other camera hardware (e.g. FLIR) coming soon
  • Camera streams are not synchronized at run time, but are saved and synchronized after the fact. This is time-consuming process that requres frames be saved in RAM until the recording is done. Both of these weaknesses have solutions in the works.

New Python developers

  1. Install Python 3.10
  2. Create Virtual Environment
  3. Install skellycam

To install Python 3.10

Windows Python3 Installation Guide

MacOSX Python3 Installation Guide

Linux Python3 Installation Guide

How to use

RECOMMENDED - Use the GUI!

Launch the GUI by running skellycam in a terminal.

This is currently the most tested method for interacting with the cameras.

Example 1 - Connecting to a single Camera and showing the video feed

Example 1 Python Fle

In this example, we connect a camera at index 0. Calling show allows us to view the cameras frames allowing us to see video.

NOTE - Work in progress, no clean way to kill this window yet

from skellycam import CameraConfig, Camera

if __name__ == "__main__":
    cam1 = Camera(CameraConfig(cam_id=0))
    cam1.connect()
    cam1.show()

Example 2 - Connect to all available cameras and record synchronized videos

NOTE - Experimental and under development, might be unstable

Example 2 Python Fle

from skellycam.experiments import MultiCameraVideoRecorder

if __name__ == "__main__":

    synchronized_video_recorder = MultiCameraVideoRecorder()
    synchronized_video_recorder.run()

Contribution Guidelines

Please read our contribution doc: CONTRIBUTING.md

Maintainers

License

This project is licensed under the APGL License - see the LICENSE file for details.

If the AGPL does not work for your needs, we are happy to discuss terms to license this software to you with a different agreement at a price point that increases exponentially as you move spiritually away from the AGPL

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

skellycam-2025.9.1097.tar.gz (1.4 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

skellycam-2025.9.1097-py3-none-any.whl (75.9 kB view details)

Uploaded Python 3

File details

Details for the file skellycam-2025.9.1097.tar.gz.

File metadata

  • Download URL: skellycam-2025.9.1097.tar.gz
  • Upload date:
  • Size: 1.4 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.9.23

File hashes

Hashes for skellycam-2025.9.1097.tar.gz
Algorithm Hash digest
SHA256 ca643210debf0e827dab35e49bb0715f37a90d49e16e472f6e2f959a68a6b8c7
MD5 2e7f62097039c7e82b7fb18e20d4371d
BLAKE2b-256 8da67d8bcb3d9817dcbf4951626b2635b114128a9beb0ff90a4ff72258170e46

See more details on using hashes here.

File details

Details for the file skellycam-2025.9.1097-py3-none-any.whl.

File metadata

File hashes

Hashes for skellycam-2025.9.1097-py3-none-any.whl
Algorithm Hash digest
SHA256 d6f489aa402acf1b8b0c52bcb3d09f93b46d5dce38388c608860dd8ea1aec511
MD5 c3547878c26211adc7d6b42e7512b4c1
BLAKE2b-256 31442a7d02a13bd7a36d03f9325362288a774e9e940628caec90804eca00992b

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page