Skip to main content

Advanced Text-Processing and -Analytics CLI Toolset.

Project description

OS-Windows OS-Linux OS-MacOS


cat_win

Advanced Text-Processing and -Analytics CLI Toolset
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

GitHub-Last-Commit Github-Stars Github-Watchers Github-Forks


Unittests Build-and-Check Coverage Tests GitHub-Issues

This project provides a cohesive collection of command-line utilities, designed to cover a broad range of everyday file and text processing tasks. It spans functionality across areas such as file inspection, text output, pattern searching, encoding/decoding, and binary data handling, and much much more ...

In addition to its command-line tools, the project includes interactive terminal applications built with curses, featuring a fully functional text editor, a hex editor, and a diff viewer. These components enable direct, in-terminal manipulation and analysis of data.

This project does not aim to exactly replicate existing tools or their specific functionalities but rather to deliver essential core features in a user-friendly manner. It is purposefully designed to be lightweight and offer a wide range of functionality without unnecessary overhead. The design focus lies with minimal dependencies and maximal compatibility across different platforms and Python versions, ensuring that it can be easily installed and used in most environments.

Made With

MadeWith-Python Python-Version

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

CurrentVersion GitHub-Release GitHub-Release-Date

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.

[!CAUTION] 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

[!TIP] 👉 A detailed Documentation of all Parameters, Configurations and General Usage 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
> >>> 0xF * 5
75 [Bin: 0b1001011, Oct: 0o113, Hex: 0x4b]
> >>> ...

(↑back to top↑)

Changelog

[!NOTE] Take a look at the Changelog file.

License

[!IMPORTANT] This software is provided "as is," without warranty of any kind. There are no guarantees of its functionality or suitability for any purpose. Use at your own risk—No responsibility for any issues, damages, or losses that may arise from using this software are taken.

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

Contact

SilenZcience
GitHub-SilenZcience

Project details


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 Distributions

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

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

cat_win-2.0.0-py3-none-any.whl (315.8 kB view details)

Uploaded Python 3

File details

Details for the file cat_win-2.0.0-py3-none-any.whl.

File metadata

  • Download URL: cat_win-2.0.0-py3-none-any.whl
  • Upload date:
  • Size: 315.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.13

File hashes

Hashes for cat_win-2.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 4eea81cfccbbf2c8490916d06b97b9970b854008ed278d715c0cd5f9afeba6af
MD5 e68c392d564ff1744b251d7e610b6ec5
BLAKE2b-256 61254e7565977d0b729192fa4ef6fee88a10782fba6d6490a36c288b2f2a446f

See more details on using hashes here.

Supported by

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