termcap 0.1.0__tar.gz

termcap-0.1.0/LICENSE

@@ -0,0 +1,29 @@
+BSD 3-Clause License
+
+Copyright (c) 2018, Nicolas Bedos
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+* Neither the name of the copyright holder nor the names of its
+  contributors may be used to endorse or promote products derived from
+  this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

termcap-0.1.0/MANIFEST.in

@@ -0,0 +1,7 @@
+include LICENSE
+include scripts/*
+recursive-include termtosvg/data *
+global-exclude __pycache__ *.pyc
+
+# Artifacts generated by the CI/CD pipeline
+include man/*.man.?

termcap-0.1.0/PKG-INFO

@@ -0,0 +1,49 @@
+Metadata-Version: 2.4
+Name: termcap
+Version: 0.1.0
+Summary: Terminal capture tool - Record terminal sessions as SVG animations
+Home-page: https://github.com/rexwzh/termcap
+Author: rexwzh
+Author-email: 1073853456@qq.com
+License: BSD 3-clause license
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: BSD License
+Classifier: Operating System :: MacOS
+Classifier: Operating System :: POSIX :: BSD
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3.5
+Classifier: Programming Language :: Python :: 3.6
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Topic :: System :: Shells
+Classifier: Topic :: Terminals
+Requires-Python: >=3.5
+License-File: LICENSE
+Requires-Dist: lxml
+Requires-Dist: pyte
+Requires-Dist: wcwidth
+Requires-Dist: click
+Requires-Dist: platformdirs
+Requires-Dist: toml
+Provides-Extra: dev
+Requires-Dist: coverage; extra == "dev"
+Requires-Dist: pylint; extra == "dev"
+Requires-Dist: twine; extra == "dev"
+Requires-Dist: wheel; extra == "dev"
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: pytest-cov; extra == "dev"
+Requires-Dist: build; extra == "dev"
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: home-page
+Dynamic: license
+Dynamic: license-file
+Dynamic: provides-extra
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+A Linux terminal recorder written in Python which renders your command line sessions as standalone SVG animations.

termcap-0.1.0/README.md

@@ -0,0 +1,189 @@
+# termcap - Terminal Capture Tool
+
+*A modern Python package for recording terminal sessions as SVG animations, based on the original [termtosvg project](https://github.com/nbedos/termtosvg).*
+
+## Overview
+
+termcap is a terminal session recorder that generates standalone SVG animations. This package is a modernized version of termtosvg with the following enhancements:
+
+- 🎯 **Modern CLI Interface**: Based on `click` with intuitive subcommands
+- ⚙️ **Configuration Management**: TOML-based configuration with `platformdirs`
+- 🎨 **Template Management**: Easy installation and management of custom templates
+- 🔧 **Enhanced User Experience**: Better error handling and user feedback
+
+## Installation
+
+```bash
+pip install termcap
+```
+
+## Quick Start
+
+### Basic Recording
+
+```bash
+# Record a terminal session
+termcap record session.cast
+
+# Render to SVG animation
+termcap render session.cast animation.svg
+```
+
+### Using Templates
+
+```bash
+# List available templates
+termcap template list
+
+# Use a specific template
+termcap render session.cast animation.svg --template gjm8
+
+# Install a custom template
+termcap template install my_template template.svg
+```
+
+### Configuration Management
+
+```bash
+# Show current configuration
+termcap config show
+
+# Set configuration values
+termcap config set general default_template my_template
+termcap config set general default_geometry 100x30
+
+# Reset to defaults
+termcap config reset
+```
+
+## Command Reference
+
+### Main Commands
+
+- `termcap record [output.cast]` - Record a terminal session
+- `termcap render input.cast [output.svg]` - Render cast file to SVG
+- `termcap --version` - Show version information
+- `termcap --help` - Show help message
+
+### Configuration Commands
+
+- `termcap config show` - Display current configuration
+- `termcap config set SECTION KEY VALUE` - Set configuration value
+- `termcap config get SECTION KEY` - Get configuration value
+- `termcap config reset` - Reset configuration to defaults
+- `termcap config templates` - List available templates
+
+### Template Commands
+
+- `termcap template list` - List all available templates
+- `termcap template install NAME FILE` - Install custom template
+- `termcap template remove NAME` - Remove custom template
+
+## Configuration
+
+termcap uses a TOML configuration file located at:
+- Linux: `~/.config/termcap/config.toml`
+- macOS: `~/Library/Application Support/termcap/config.toml`
+- Windows: `%APPDATA%\termcap\config.toml`
+
+### Default Configuration
+
+```toml
+[general]
+default_template = "gjm8"
+default_geometry = "82x19"
+default_min_duration = 17
+default_max_duration = 3000
+default_loop_delay = 1000
+
+[templates]
+custom_templates_enabled = true
+builtin_templates_enabled = true
+
+[output]
+default_output_dir = "~/termcap_recordings"
+auto_timestamp = true
+```
+
+## Templates
+
+### Built-in Templates
+
+termcap includes several built-in templates:
+- `gjm8` - Default colorful template
+- `dracula` - Dark theme with purple accents
+- `solarized_dark` / `solarized_light` - Solarized color schemes
+- `ubuntu` - Ubuntu-styled terminal
+- `putty` - PuTTY-like appearance
+- `window_frame` - Terminal with window frame
+- And more...
+
+### Custom Templates
+
+Custom templates are stored in:
+- Linux: `~/.config/termcap/templates/`
+- macOS: `~/Library/Application Support/termcap/templates/`
+- Windows: `%APPDATA%\termcap\templates\`
+
+## Migration from termtosvg
+
+If you're migrating from termtosvg, termcap maintains backward compatibility:
+
+```bash
+# These commands work the same way
+termcap animation.svg
+termcap record session.cast
+termcap render session.cast animation.svg
+
+# But you can also use the new modern interface
+termcap record session.cast
+termcap render session.cast animation.svg --template dracula
+```
+
+## Development
+
+### Requirements
+
+- Python 3.5+
+- click
+- platformdirs
+- toml
+- lxml
+- pyte
+- wcwidth
+
+### Testing
+
+```bash
+python -m pytest termcap/tests/
+```
+
+### Contributing
+
+1. Fork the repository
+2. Create a feature branch
+3. Make your changes
+4. Add tests
+5. Submit a pull request
+
+## License
+
+BSD 3-clause license (same as original termtosvg)
+
+## Author
+
+- **termcap**: rexwzh (1073853456@qq.com)
+- **Original termtosvg**: Nicolas Bedos
+
+## Changelog
+
+### Version 0.1.0
+
+- ✅ Rebranded as termcap
+- ✅ Added click-based modern CLI interface
+- ✅ Added TOML configuration management
+- ✅ Added platformdirs for proper config directory handling
+- ✅ Added template management commands
+- ✅ Maintained full backward compatibility
+- ✅ Improved error handling and user feedback
+- ✅ 56 comprehensive tests ensure reliability

termcap-0.1.0/scripts/termcap

@@ -0,0 +1,6 @@
+#!/usr/bin/env python3
+
+import termcap.cli
+
+if __name__ == '__main__':
+    termcap.cli.main()

termcap-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

termcap-0.1.0/setup.py

@@ -0,0 +1,57 @@
+#!/usr/bin/env python
+
+from setuptools import setup, find_packages
+
+setup(
+    name='termcap',
+    version='0.1.0',
+    license='BSD 3-clause license',
+    author='rexwzh',
+    author_email='1073853456@qq.com',
+    description='Terminal capture tool - Record terminal sessions as SVG animations',
+    long_description='A Linux terminal recorder written in Python '
+                     'which renders your command line sessions as '
+                     'standalone SVG animations.',
+    url='https://github.com/rexwzh/termcap',
+    classifiers=[
+        'Environment :: Console',
+        'Intended Audience :: Developers',
+        'License :: OSI Approved :: BSD License',
+        'Operating System :: MacOS',
+        'Operating System :: POSIX :: BSD',
+        'Operating System :: POSIX :: Linux',
+        'Programming Language :: Python',
+        'Programming Language :: Python :: 3.5',
+        'Programming Language :: Python :: 3.6',
+        'Programming Language :: Python :: 3.7',
+        'Topic :: System :: Shells',
+        'Topic :: Terminals'
+    ],
+    python_requires='>=3.5',
+    packages=['termcap'],  # 只包含 termcap 包
+    entry_points={
+        'console_scripts': [
+            'termcap=termcap.cli:main',
+        ],
+    },
+    include_package_data=True,
+    install_requires=[
+        'lxml',
+        'pyte',
+        'wcwidth',
+        'click',
+        'platformdirs',
+        'toml',
+    ],
+    extras_require={
+        'dev': [
+            'coverage',
+            'pylint',
+            'twine',
+            'wheel',
+            'pytest',
+            'pytest-cov',
+            'build',
+        ]
+    }
+)