Automatically generate documentation from screen interactions
Project description
Screen2Doc
Screen2Doc is a Python package that lets you automatically create step-by-step documentation by capturing screenshots and adding annotations.
Features
- Manual screen capture
- Annotate each step
- Export to Markdown
Installation
pip install screen2doc
Usage
from screen2doc import ScreenCapturer, AnnotationManager, Exporter
capturer = ScreenCapturer()
annotator = AnnotationManager()
exporter = Exporter()
step1 = capturer.capture()
annotator.add_annotation(1, "Open Settings")
step2 = capturer.capture()
annotator.add_annotation(2, "Go to Network Settings")
exporter.export_markdown(capturer.get_steps(), annotator.get_all_annotations())
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
screen2doc-0.1.0.tar.gz
(1.7 kB
view details)
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file screen2doc-0.1.0.tar.gz.
File metadata
- Download URL: screen2doc-0.1.0.tar.gz
- Upload date:
- Size: 1.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.10.11
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
2e388dd567e03a83e06f3460067c410c67f9ed9f9714395450b14c0d855debca
|
|
| MD5 |
4c643078ad1001bc11cbc817b8ff34a4
|
|
| BLAKE2b-256 |
0ab0c139c076b1e8de50116e7fa3885ab0efe64dd4db2916301ba28b9d7eef54
|
File details
Details for the file screen2doc-0.1.0-py3-none-any.whl.
File metadata
- Download URL: screen2doc-0.1.0-py3-none-any.whl
- Upload date:
- Size: 1.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.10.11
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
b7856c1beb48af07aefaed8450bdfb5fb1de8de7fe8d42c3987db2316f0bf868
|
|
| MD5 |
4884db9eadaadb1d6ce52a615a4b9926
|
|
| BLAKE2b-256 |
35f066453b2921e8c89c5977206e46ad8252be37962d27576a25badf60ac254a
|
