cat-win


Namecat-win JSON
Version 1.0.33 PyPI version JSON
download
home_page
SummarySimple OS Independent 'cat' Command-line Tool made in Python.
upload_time2023-01-30 17:56:10
maintainer
docs_urlNone
author
requires_python>=3.7
license
keywords python cli
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            <div id="top"></div>

<p>
   <a href="https://pypi.org/project/cat-win/" alt="Downloads">
      <img src="https://static.pepy.tech/personalized-badge/cat-win?period=total&units=international_system&left_color=grey&right_color=orange&left_text=Downloads" align="right">
   </a>
   <a href="https://pypi.org/project/cat-win/" alt="Visitors">
      <img src="https://visitor-badge.laobi.icu/badge?page_id=SilenZcience.cat_win" align="right">
   </a>
</p>

[![OS-Windows]][OS-Windows]
[![OS-Linux]][OS-Linux]
[![OS-MacOS]][OS-MacOS]

<br/>
<div align="center">
<h2 align="center">cat_win</h2>
   <p align="center">
      Simple Command-line Tool made in Python
      <br/>
      <a href="https://github.com/SilenZcience/cat_win/blob/main/cat_win/cat.py">
         <strong>Explore the code »</strong>
      </a>
      <br/>
      <br/>
      <a href="https://github.com/SilenZcience/cat_win/issues">Report Bug</a>
      ·
      <a href="https://github.com/SilenZcience/cat_win/issues">Request Feature</a>
   </p>
</div>


<details>
   <summary>Table of Contents</summary>
   <ol>
      <li>
         <a href="#about-the-project">About The Project</a>
         <ul>
            <li><a href="#made-with">Made With</a></li>
         </ul>
      </li>
      <li>
         <a href="#getting-started">Getting Started</a>
         <ul>
            <li><a href="#prerequisites">Prerequisites</a></li>
            <li><a href="#installation">Installation</a></li>
         </ul>
      </li>
      <li><a href="#usage">Usage</a>
         <ul>
         <li><a href="#examples">Examples</a></li>
         </ul>
      </li>
      <li><a href="#license">License</a></li>
      <li><a href="#contact">Contact</a></li>
   </ol>
</details>

## About The Project

This project copies the fundamental framework of the cat command-line tool from linux and translates its features to an OS Independent file.

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, and even convert decimal, hexadecimal and binary numbers within any text.

### Made With
[![Python][MadeWith-Python]](https://www.python.org/)

<p align="right">(<a href="#top">back to top</a>)</p>

## Getting Started

### Prerequisites

No Prerequisites are neccessary; The stand-alone executable `cat.exe` is sufficient.

> ⚠️ **You should never trust any executable file!**

### Installation

1. Clone the repository and move into the root\bin directory with:
```console
git clone git@github.com:SilenZcience/cat_win.git
cd cat_win\bin
```
2. Add the directory to your system-environment `PATH`-variables.

or simply install the python package ([PyPI-cat_win](https://pypi.org/project/cat-win/)):
```console
pip install cat-win
```
<p align="right">(<a href="#top">back to top</a>)</p>

## Usage

```console
cat [FILE]... [OPTION]...

cat --help
```

⚠️ *on linux or macOS systems you might need to define an alias or use:*
```console
python3 -m cat_win [FILE]... [OPTION]...

python3 -m cat_win --help
```

<table>
   <!-- <tr><th> </th><th> </th></tr> -->
   <tr><td>

| Argument               | Description                                       |
|------------------------|---------------------------------------------------|
| -n, --number           | number all output lines                           |
| -x, --linelength       | display the length of each line                   |
| -e, --ends             | display $ at the end of each line                 |
| -t, --tabs             | display TAB characters as ^I                      |
| --eof, --eof           | display EOF characters as ^EOF                    |
| -s, --squeeze          | suppress repeated output lines                    |
| -r, --reverse          | reverse output                                    |
| -c, --count            | show sum of lines                                 |
| -b, --blank            | hide empty lines                                  |
| -f, --files            | list applied files                                |
| -i, --interactive      | use stdin                                         |
| -o, --oneline          | take only the first stdin-line                    |
| -p, --peek             | only print the first and last lines               |
| -l, --clip             | copy output to clipboard                          |
| -m, --checksum         | show the checksums of all files                   |
| -a, --attributes       | show meta-information about the files             |

   </td>
   <td>

| Argument               | Description                                       |
|------------------------|---------------------------------------------------|
| -dec, --dec            | convert decimal numbers to hexadecimal and binary |
| -hex, --hex            | convert hexadecimal numbers to decimal and binary |
| -bin, --bin            | convert binary numbers to decimal and hexadecimal |
|                        |                                                   |
| -col, --nocolor        | disable colored output                            |
| --config, --config     | change color configuration                        |
|                        |                                                   |
| --b64e, --b64e         | encode the input to base64                        |
| --b64d, --b64d         | decode the input from base64                      |
|                        |                                                   |
| enc=X                  | set file enconding to X (default is utf-8)        |
| find=X                 | find substring X in the given files               |
| match=X                | find pattern X in the given files                 |
| trunc=X:Y              | truncate file to lines X and Y (python-like)      |
|                        |                                                   |
| [a,b]                  | replace a with b in every line                    |
| [a:b]                  | python-like string manipulation syntax            |
|                        |                                                   |
| -h, --help             | show help message and exit                        |
| -v, --version          | output version information                        |
| -d, --debug            | show debug information                            |

   </td>
   </tr>
</table>

### Examples

![Example1](https://raw.githubusercontent.com/SilenZcience/cat_win/main/img/example1.png "example1")

![Example2](https://raw.githubusercontent.com/SilenZcience/cat_win/main/img/example2.png "example2")

![Example3](https://raw.githubusercontent.com/SilenZcience/cat_win/main/img/example3.png "example3")

![Example4](https://raw.githubusercontent.com/SilenZcience/cat_win/main/img/example4.png "example4")

<p align="right">(<a href="#top">back to top</a>)</p>

## License

This project is licensed under the MIT License - see the [LICENSE](https://github.com/SilenZcience/cat_win/blob/main/LICENSE) file for details

## Contact

> **SilenZcience** <br/>
[![GitHub-SilenZcience][GitHub-SilenZcience]](https://github.com/SilenZcience)

[OS-Windows]: https://svgshare.com/i/ZhY.svg
[OS-Linux]: https://svgshare.com/i/Zhy.svg
[OS-MacOS]: https://svgshare.com/i/ZjP.svg

[MadeWith-Python]: https://img.shields.io/badge/Made%20with-Python-brightgreen

[GitHub-SilenZcience]: https://img.shields.io/badge/GitHub-SilenZcience-orange

            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "cat-win",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.7",
    "maintainer_email": "",
    "keywords": "python,cli",
    "author": "",
    "author_email": "\"Silas A. Kraume\" <silas.kraume1552@gmail.com>",
    "download_url": "",
    "platform": null,
    "description": "<div id=\"top\"></div>\n\n<p>\n   <a href=\"https://pypi.org/project/cat-win/\" alt=\"Downloads\">\n      <img src=\"https://static.pepy.tech/personalized-badge/cat-win?period=total&units=international_system&left_color=grey&right_color=orange&left_text=Downloads\" align=\"right\">\n   </a>\n   <a href=\"https://pypi.org/project/cat-win/\" alt=\"Visitors\">\n      <img src=\"https://visitor-badge.laobi.icu/badge?page_id=SilenZcience.cat_win\" align=\"right\">\n   </a>\n</p>\n\n[![OS-Windows]][OS-Windows]\n[![OS-Linux]][OS-Linux]\n[![OS-MacOS]][OS-MacOS]\n\n<br/>\n<div align=\"center\">\n<h2 align=\"center\">cat_win</h2>\n   <p align=\"center\">\n      Simple Command-line Tool made in Python\n      <br/>\n      <a href=\"https://github.com/SilenZcience/cat_win/blob/main/cat_win/cat.py\">\n         <strong>Explore the code \u00bb</strong>\n      </a>\n      <br/>\n      <br/>\n      <a href=\"https://github.com/SilenZcience/cat_win/issues\">Report Bug</a>\n      \u00b7\n      <a href=\"https://github.com/SilenZcience/cat_win/issues\">Request Feature</a>\n   </p>\n</div>\n\n\n<details>\n   <summary>Table of Contents</summary>\n   <ol>\n      <li>\n         <a href=\"#about-the-project\">About The Project</a>\n         <ul>\n            <li><a href=\"#made-with\">Made With</a></li>\n         </ul>\n      </li>\n      <li>\n         <a href=\"#getting-started\">Getting Started</a>\n         <ul>\n            <li><a href=\"#prerequisites\">Prerequisites</a></li>\n            <li><a href=\"#installation\">Installation</a></li>\n         </ul>\n      </li>\n      <li><a href=\"#usage\">Usage</a>\n         <ul>\n         <li><a href=\"#examples\">Examples</a></li>\n         </ul>\n      </li>\n      <li><a href=\"#license\">License</a></li>\n      <li><a href=\"#contact\">Contact</a></li>\n   </ol>\n</details>\n\n## About The Project\n\nThis project copies the fundamental framework of the cat command-line tool from linux and translates its features to an OS Independent file.\n\nAdditionally 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, and even convert decimal, hexadecimal and binary numbers within any text.\n\n### Made With\n[![Python][MadeWith-Python]](https://www.python.org/)\n\n<p align=\"right\">(<a href=\"#top\">back to top</a>)</p>\n\n## Getting Started\n\n### Prerequisites\n\nNo Prerequisites are neccessary; The stand-alone executable `cat.exe` is sufficient.\n\n> \u26a0\ufe0f **You should never trust any executable file!**\n\n### Installation\n\n1. Clone the repository and move into the root\\bin directory with:\n```console\ngit clone git@github.com:SilenZcience/cat_win.git\ncd cat_win\\bin\n```\n2. Add the directory to your system-environment `PATH`-variables.\n\nor simply install the python package ([PyPI-cat_win](https://pypi.org/project/cat-win/)):\n```console\npip install cat-win\n```\n<p align=\"right\">(<a href=\"#top\">back to top</a>)</p>\n\n## Usage\n\n```console\ncat [FILE]... [OPTION]...\n\ncat --help\n```\n\n\u26a0\ufe0f *on linux or macOS systems you might need to define an alias or use:*\n```console\npython3 -m cat_win [FILE]... [OPTION]...\n\npython3 -m cat_win --help\n```\n\n<table>\n   <!-- <tr><th> </th><th> </th></tr> -->\n   <tr><td>\n\n| Argument               | Description                                       |\n|------------------------|---------------------------------------------------|\n| -n, --number           | number all output lines                           |\n| -x, --linelength       | display the length of each line                   |\n| -e, --ends             | display $ at the end of each line                 |\n| -t, --tabs             | display TAB characters as ^I                      |\n| --eof, --eof           | display EOF characters as ^EOF                    |\n| -s, --squeeze          | suppress repeated output lines                    |\n| -r, --reverse          | reverse output                                    |\n| -c, --count            | show sum of lines                                 |\n| -b, --blank            | hide empty lines                                  |\n| -f, --files            | list applied files                                |\n| -i, --interactive      | use stdin                                         |\n| -o, --oneline          | take only the first stdin-line                    |\n| -p, --peek             | only print the first and last lines               |\n| -l, --clip             | copy output to clipboard                          |\n| -m, --checksum         | show the checksums of all files                   |\n| -a, --attributes       | show meta-information about the files             |\n\n   </td>\n   <td>\n\n| Argument               | Description                                       |\n|------------------------|---------------------------------------------------|\n| -dec, --dec            | convert decimal numbers to hexadecimal and binary |\n| -hex, --hex            | convert hexadecimal numbers to decimal and binary |\n| -bin, --bin            | convert binary numbers to decimal and hexadecimal |\n|                        |                                                   |\n| -col, --nocolor        | disable colored output                            |\n| --config, --config     | change color configuration                        |\n|                        |                                                   |\n| --b64e, --b64e         | encode the input to base64                        |\n| --b64d, --b64d         | decode the input from base64                      |\n|                        |                                                   |\n| enc=X                  | set file enconding to X (default is utf-8)        |\n| find=X                 | find substring X in the given files               |\n| match=X                | find pattern X in the given files                 |\n| trunc=X:Y              | truncate file to lines X and Y (python-like)      |\n|                        |                                                   |\n| [a,b]                  | replace a with b in every line                    |\n| [a:b]                  | python-like string manipulation syntax            |\n|                        |                                                   |\n| -h, --help             | show help message and exit                        |\n| -v, --version          | output version information                        |\n| -d, --debug            | show debug information                            |\n\n   </td>\n   </tr>\n</table>\n\n### Examples\n\n![Example1](https://raw.githubusercontent.com/SilenZcience/cat_win/main/img/example1.png \"example1\")\n\n![Example2](https://raw.githubusercontent.com/SilenZcience/cat_win/main/img/example2.png \"example2\")\n\n![Example3](https://raw.githubusercontent.com/SilenZcience/cat_win/main/img/example3.png \"example3\")\n\n![Example4](https://raw.githubusercontent.com/SilenZcience/cat_win/main/img/example4.png \"example4\")\n\n<p align=\"right\">(<a href=\"#top\">back to top</a>)</p>\n\n## License\n\nThis project is licensed under the MIT License - see the [LICENSE](https://github.com/SilenZcience/cat_win/blob/main/LICENSE) file for details\n\n## Contact\n\n> **SilenZcience** <br/>\n[![GitHub-SilenZcience][GitHub-SilenZcience]](https://github.com/SilenZcience)\n\n[OS-Windows]: https://svgshare.com/i/ZhY.svg\n[OS-Linux]: https://svgshare.com/i/Zhy.svg\n[OS-MacOS]: https://svgshare.com/i/ZjP.svg\n\n[MadeWith-Python]: https://img.shields.io/badge/Made%20with-Python-brightgreen\n\n[GitHub-SilenZcience]: https://img.shields.io/badge/GitHub-SilenZcience-orange\n",
    "bugtrack_url": null,
    "license": "",
    "summary": "Simple OS Independent 'cat' Command-line Tool made in Python.",
    "version": "1.0.33",
    "split_keywords": [
        "python",
        "cli"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "9d7fb816b5775840f9ea91311b0e1ba04d17ad23d94d10cf4ed16094716a8e7c",
                "md5": "ac58714c3df201949d3bdf2497c2ea18",
                "sha256": "3e13c5b689591bbcf34a0592900774bee8a71bf2e7285c4bc6d97b327a2d4e5c"
            },
            "downloads": -1,
            "filename": "cat_win-1.0.33-py3-none-any.whl",
            "has_sig": true,
            "md5_digest": "ac58714c3df201949d3bdf2497c2ea18",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.7",
            "size": 23438,
            "upload_time": "2023-01-30T17:56:10",
            "upload_time_iso_8601": "2023-01-30T17:56:10.170557Z",
            "url": "https://files.pythonhosted.org/packages/9d/7f/b816b5775840f9ea91311b0e1ba04d17ad23d94d10cf4ed16094716a8e7c/cat_win-1.0.33-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-01-30 17:56:10",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "lcname": "cat-win"
}
        
Elapsed time: 0.11889s