Skip to content

Simple OS Independent Text-Processing and -Analytics Command Line Tool made in Python.

License

Notifications You must be signed in to change notification settings

SilenZcience/cat_win

Repository files navigation

OS-Windows OS-Linux OS-MacOS


cat_win

Simple Text-Processing and -Analytics Command Line Tool made in Python
Explore the code »

Request Feature · Report Bug · Request Documentation

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Changelog
  5. License
  6. Contact

🔥 About The Project

Unittests Build-and-Check Coverage Tests

This project copies the fundamental framework of the cat command-line tool from Unix and translates its features to an OS Independent program using Python.
The project has evolved into many other subject areas like 'echo', 'grep', 'ls', 'base64'...

Additionally it includes an editor and a hex editor aswell as the feature to manipulate the content of any given file in countless ways, generating the checksum of any file, converting hexadecimal, decimal, octal and binary numbers within any text, and much much more ...

Made With

MadeWith-Python Python

(↑back to top↑)

🚀 Getting Started

Prerequisites

Using cat_win as a Python Package demands a Python-Interpreter (>= 3.6).

Using cat_win as a Binary Executable demands no prerequisites, hereby the stand-alone executables are sufficient.

Installation

Version

Python Package
Simply install the python package (via PyPI-cat_win):

python -m pip install -U cat_win[clip]
python -m pip install -U cat_win

cat_win uses the pyperclip module by default. Should any problems occur, you can also use the pyperclip3 or pyclip module. In this case simply don't install with [clip] and manually install the desired module yourself.

On older Windows systems colored output may not be displayed correctly. In this case you can try to fix the problem by installing the cat_win-package with the optional color-fix [cfix] dependency. This fix will use the colorama module which can also be installed after the fact to patch the problem.

Binary Executable
OR alternatively you can use the (standalone) binary executable version:

Direct Download:
Windows - catw.exe
Windows - cats.exe (REPL)
Linux - catw
Linux - cats (REPL)
MacOS - catw
MacOS - cats (REPL)

(compiled using PyInstaller)
It is recommended to add the file path(s) to your system-environment PATH-variables.

❗️ You should never trust any executable file! Feel free to compile the package yourself (e.g. using PyInstaller).

⚠️ You can verify the creation of the executable files yourself by reading the source code, checking the origin of the file and validating the corresponding workflow used.

(↑back to top↑)

🔧 Usage

> catw [FILE]... [OPTION]...
> catw --help
Concatenate FILE(s) to standard output.
...
> cats [OPTION]...
> cats --help
Interactively manipulate standard input.
...

Documentation

👉 A detailed 💡Documentation💡 of all Parameters has moved to another File. Read about specific Arguments & Options here.

Examples

📂 Images 📂



$ echo "Hello World :)" | catw - [6:] | catw - [::-1] -ln
> 1) [8] ): dlroW

$ cats --eval --dec -nl
> >>> 0xF * 5
1) [42] 75 [Bin: 0b1001011, Oct: 0o113, Hex: 0x4b]
> >>> ...

(↑back to top↑)

📋 Changelog

Take a look at the Changelog file.

📜 License

This project is licensed under the MIT License - see the LICENSE file for details

💫 Contact

SilenZcience
GitHub-SilenZcience