Metadata-Version: 2.4
Name: TermuxC
Version: 2.6.2
Summary: A lightweight utility to copy text to the device clipboard using OSC 52.
Author: Ruizennis
License: MIT
Project-URL: Homepage, https://github.com/Ruizennis/TermuxC
Project-URL: Issues, https://github.com/Ruizennis/TermuxC/issues
Project-URL: Changelog, https://github.com/Ruizennis/TermuxC/blob/main/CHANGELOG.md
Project-URL: Documentation, https://Ruizennis.github.io/TermuxC/
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: POSIX :: Linux
Classifier: Environment :: Console
Classifier: Topic :: Utilities
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Dynamic: license-file

# TermuxC 
### Termux copy to clipboard made easy.
## Also known as TermuxCopy
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
[![Python Version](https://img.shields.io/badge/python-3.10%2B-blue.svg)](https://www.python.org)
[![PyPI version](https://img.shields.io/pypi/v/TermuxC.svg?color=blue)](https://pypi.org/project/TermuxC/)
[![PyPI downloads](https://img.shields.io/pypi/dm/TermuxC.svg)](https://pypi.org/project/TermuxC/)


This dual function pip package & cli tool was made to solve an issue with Termux, not allowing copying to device clipboard easily without their companion app; This package solves that.

## Cli Tool Usage:

### Copy text
```bash
termuxc text
```
**Or**
```bash
echo "test" | termuxc
```
### Copy text from file
```bash
cat filename | termuxc
```
### Copy text from file using the read from file flag
```bash
termuxc -f filename
```

### Copy current working directory
```bash
pwd | termuxc
```
Also compatible with
- bat
- grep
- curl
- head
- tail
## Pip package Usage:

### Copy text
```python
from TermuxC import copy
copy("Str") # works with strings,
copy(1) # numbers
copy(1.3) # and floats!
```

### Copy text from file
```python
from TermuxC import copy
with open("filename", "r") as f:
    content = f.read()
    copy(content)
```
### Copy current working directory
```python
from TermuxC import copy
import os
copy(os.getcwd())
```

## Installation 
Install pip package
```bash
pip install TermuxC
```

## Uninstallation
Uninstall pip package
```bash
pip uninstall TermuxC
```
## Flags
|Flag|Function        |
|----|----------------|
| -f | Read from file |
| -i | Interactive mode|
| -h | Show help menu |
| -V | Show package version|
#### Additional flag aliases
- --file
- --interactive
- --help
- --version

## Handling special characters
### Some text may get interpreted incorrectly by the bash (or zsh) interpreter, to fix this issue wrap your text in single or double quotes

### Incorrect:
```
termuxc (
```
This will throw an error!
### Correct:
```
termuxc "("
```
This will copy the text successfully!

## Requirements:
**Python 3.10+**

View Package here!  
[Pypi - TermuxC](https://pypi.org/project/TermuxC/)

Create an issue here!  
[Issues](https://github.com/Ruizennis/TermuxC/issues)

View changelog here!  
[Changelog](https://github.com/Ruizennis/TermuxC/blob/main/CHANGELOG.md)

View the documentation here!  
[Documentstion](https://Ruizennis.github.io/TermuxC/)

### Tmux support
#### To allow TermuxC to work inside of termux add "set -g allow-passthrough on" to your tmux configuration file.

# License
## This project is licensed under the MIT license, see [LICENSE](LICENSE)
