Skip to main content

A simple tool to stream camera in shell.

Project description

CamShell

CamShell, A simple way to stream a camera as ASCII art directly in a terminal.

Installation

Using pip:

pip install camshell

How to Use

CLI Usage:

After installation, you can run the camshell command-line tool or by providing the device id.

# Run the default device
camshell

# Or run by device-id
camshell 1

# Or a device path specifically
camshell /dev/video3

# Or stream from a file
camshell -f ./my_video.mp4

Python API Usage

If you’d like to use CamShell in your Python code, here’s how:

from camshell import CamShell

# simply call:
device_id = "/dev/video0"
CamShell.start(device_index=device_id)

# or in case of MacOS
CamShell.start(avf_source=True)

Run on a custom screen

from camshell import CamShell
from camshell.display import Display
from camshell.vision.camera import GenericCamera

# Create a GStream-based camera object
camera = GenericCamera(device_index=cap_id, avf_source=True)

# Create a Curses display
display = Display()

# Create and run the CamShell
cs = CamShell(camera, display)
cs.initialize()
cs.run()

Output Example

Example Output

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

camshell-0.1.6.tar.gz (9.9 kB view details)

Uploaded Source

Built Distribution

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

camshell-0.1.6-py3-none-any.whl (12.4 kB view details)

Uploaded Python 3

File details

Details for the file camshell-0.1.6.tar.gz.

File metadata

  • Download URL: camshell-0.1.6.tar.gz
  • Upload date:
  • Size: 9.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.13.1

File hashes

Hashes for camshell-0.1.6.tar.gz
Algorithm Hash digest
SHA256 bcd97fe2d96d7b31195a7e4d38799c88e41bd9086f22fa450d7a1cabd7196d04
MD5 50e56d2496b400d189c343f4628b9684
BLAKE2b-256 82ed8b6bc3a8dd766f2b022c922f4ccdea02406e03cfa0e4c426dc7e08f5abc7

See more details on using hashes here.

File details

Details for the file camshell-0.1.6-py3-none-any.whl.

File metadata

  • Download URL: camshell-0.1.6-py3-none-any.whl
  • Upload date:
  • Size: 12.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.13.1

File hashes

Hashes for camshell-0.1.6-py3-none-any.whl
Algorithm Hash digest
SHA256 37f9f10f2998ed1df84106a42a142d1e700e1465cde7365edf2417f275a095d8
MD5 76152a9e1306f2733aa96dc7cab30a84
BLAKE2b-256 18c14d6274592574f392e8acb9a492b8c293a19a76de2b5ba253a46742a263d7

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