Skip to main content

Simple OS Independent 'cat' Command-line Tool made in Python.

Project description

OS-Windows OS-Linux OS-MacOS


cat_win

Simple Command-line Tool made in Python
Explore the code »

Report Bug · Request Feature

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 Linux and translates its features to an OS Independent program using Python.
Over time the project evolved in subject areas of other tools like 'echo', 'grep', 'ls', 'base64'.

Additionally it includes the feature to strip and reverse the content of any given file, make use of the standard-input, which enables cat piping into each other, generating the checksum of any file, converting decimal, hexadecimal and binary numbers within any text, and much more ...

It is of course possible to use cat_win on Linux or MacOS, aswell as Windows!

Made With

MadeWith-Python Python

(back to top)

Getting Started

Prerequisites

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

Binary Executable
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 --upgrade cat_win[clip]

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 run:

python -m pip install --upgrade cat_win

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 (shell)
Linux - catw
Linux - cats (shell)
MacOS - catw
MacOS - cats (shell)

(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.
...

👉 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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

cat_win-1.7.3-py3-none-any.whl (101.1 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page