Skip to main content

Segmented screen recording helpers built on ffmpeg.

Project description

recordflow

Convenience helpers for recording segmented screen captures on macOS using ffmpeg.

Installation

Build and install locally while iterating:

python -m pip install --upgrade build
python -m build        # creates dist/*.tar.gz and dist/*.whl
python -m pip install dist/recordflow-0.1.0-py3-none-any.whl

After publishing a release to PyPI the package can be installed with:

python -m pip install recordflow

Quickstart

Record the screen for a fixed duration and return the created session directory:

from recordflow import record_screen

session_dir = record_screen(duration_seconds=30, fps=5, resolution="1440x900")
print("Segments stored in:", session_dir)

Run ad-hoc recordings with custom logic inside a with block:

from time import sleep
from recordflow import recording_session

with recording_session(fps=2, segment_minutes=1) as recorder:
    sleep(10)
    print("Current segment:", recorder.current_segment)

Use the bundled CLI to keep capturing until interrupted:

recordflow live --fps 5 --segment-minutes 2

Development

Run the lightweight unit test suite with:

python -m unittest discover -s tests -p "test*.py"

Publishing

  1. Update the version in pyproject.toml.
  2. Build fresh distributions with python -m build.
  3. Upload with python -m twine upload dist/*.

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

recordflow-0.1.0.tar.gz (10.0 kB view details)

Uploaded Source

Built Distribution

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

recordflow-0.1.0-py3-none-any.whl (11.2 kB view details)

Uploaded Python 3

File details

Details for the file recordflow-0.1.0.tar.gz.

File metadata

  • Download URL: recordflow-0.1.0.tar.gz
  • Upload date:
  • Size: 10.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.9.6

File hashes

Hashes for recordflow-0.1.0.tar.gz
Algorithm Hash digest
SHA256 e1b20cfd7a1deb39fe96b278559ba6fdeeb904827acdfec6ee8bf4e4fd2f4849
MD5 3c5a66bbb1042714cb1a7cfb659c45a6
BLAKE2b-256 d20a935350fbd037eb86a969473a87eaa30f7228262d3eb133f0297a53a2b55b

See more details on using hashes here.

File details

Details for the file recordflow-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: recordflow-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 11.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.9.6

File hashes

Hashes for recordflow-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 450f657a2e7cc16552b9b0e0b13cae20958ad9a84cb53a77169aed73dd4e7c5c
MD5 a45d41a3bf4bd617a337c519791a98a4
BLAKE2b-256 ea7e500d8272b34b671a82ec971a2ef8543eebc89532d2269a082145c4b5094d

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