python-cath

Cat files w/ headers

Installation

pip install python-cath

or install with Poetry

poetry add python-cath

Then you can run

python-cath --help

python-cath file1 file2 outfile

or if installed with Poetry:

poetry run python-cath --help

poetry run python-cath file1 file2 outfile

Makefile usage

Makefile contains many functions for fast assembling and convenient work.

1. Download Poetry

make download-poetry

2. Install all dependencies and pre-commit hooks

make install

If you do not want to install pre-commit hooks, run the command with the NO_PRE_COMMIT flag:

make install NO_PRE_COMMIT=1

3. Check the security of your code

make check-safety

This command launches a Poetry and Pip integrity check as well as identifies security issues with Safety and Bandit. By default, the build will not crash if any of the items fail. But you can set STRICT=1 for the entire build, or you can configure strictness for each item separately.

make check-safety STRICT=1

or only for safety:

make check-safety SAFETY_STRICT=1

multiple

make check-safety PIP_STRICT=1 SAFETY_STRICT=1

List of flags for check-safety (can be set to 1 or 0): STRICT, POETRY_STRICT, PIP_STRICT, SAFETY_STRICT, BANDIT_STRICT.

4. Check the codestyle

The command is similar to check-safety but to check the code style, obviously. It uses Black, Darglint, Isort, and Mypy inside.

make check-style

It may also contain the STRICT flag.

make check-style STRICT=1

List of flags for check-style (can be set to 1 or 0): STRICT, BLACK_STRICT, DARGLINT_STRICT, ISORT_STRICT, MYPY_STRICT.

5. Run all the codestyle formaters

Codestyle uses pre-commit hooks, so ensure you've run make install before.

make codestyle

6. Run tests

make test

7. Run all the linters

make lint

the same as:

make test && make check-safety && make check-style

List of flags for lint (can be set to 1 or 0): STRICT, POETRY_STRICT, PIP_STRICT, SAFETY_STRICT, BANDIT_STRICT, BLACK_STRICT, DARGLINT_STRICT, ISORT_STRICT, MYPY_STRICT.

8. Build docker

make docker

which is equivalent to:

make docker VERSION=latest

More information here.

9. Cleanup docker

make clean_docker

or to remove all build

make clean

More information here.

📈 Releases

You can see the list of available releases on the GitHub Releases page.

We follow Semantic Versions specification.

We use Release Drafter. As pull requests are merged, a draft release is kept up-to-date listing the changes, ready to publish when you’re ready. With the categories option, you can categorize pull requests in release notes using labels.

For Pull Request this labels are configured, by default:

Label	Title in Releases
`enhancement`, `feature`	🚀 Features
`bug`, `refactoring`, `bugfix`, `fix`	🔧 Fixes & Refactoring
`build`, `ci`, `testing`	📦 Build System & CI/CD
`breaking`	💥 Breaking Changes
`documentation`	📝 Documentation
`dependencies`	⬆️ Dependencies updates

You can update it in release-drafter.yml.

GitHub creates the bug, enhancement, and documentation labels for you. Dependabot creates the dependencies label. Create the remaining labels on the Issues tab of your GitHub repository, when you need them.

🛡 License

This project is licensed under the terms of the MIT license. See LICENSE for more details.

📃 Citation

@misc{python-cath,
  author = {samesense},
  title = {Cat files w/ headers},
  year = {2020},
  publisher = {GitHub},
  journal = {GitHub repository},
  howpublished = {\url{https://github.com/samesense/python-cath}}
}

Credits

This project was generated with python-package-template.

Metadata

Release files for python-cath 0.4.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for python-cath 0.4.1
File	Size	Uploaded
python_cath-0.4.1.tar.gz	5.1 kB	Jun 12, 2026	Details

Built distribution (wheel)

Table of built distributions (wheels) for python-cath 0.4.1
File	Interpreter	ABI	Platform	Reset
python_cath-0.4.1-py3-none-any.whl 6.2 kB Jun 12, 2026	Python 3	none	any	Details

Total release size: 11.4 kB

Release files / python_cath-0.4.1.tar.gz

Download URL	python_cath-0.4.1.tar.gz
Size	5.1 kB
Tags	Source
SHA-256 checksum How to use checksums	`9287e5fba68021ff72295292f1f2bfdcf6d30bbdd00bc862d51ce88c893f41be`
BLAKE2b-256 checksum How to use checksums	`e759b92f1db92f0bde99290c63d8d25e0a7ec8a2a85b3de7c6556c1ced90c2aa`
Upload date	Jun 12, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`poetry/2.3.2 CPython/3.14.3 Darwin/25.5.0`

Release files / python_cath-0.4.1-py3-none-any.whl

Download URL	python_cath-0.4.1-py3-none-any.whl
Size	6.2 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`760fe0ea11c60b75d88aedd11a18cdf42f629806072d5f240050bf7564ebfc1c`
BLAKE2b-256 checksum How to use checksums	`291ef283f66a7a5f5138ace3ca7fd3a72113e5b52a498b5b620c7f5d4bc0936c`
Upload date	Jun 12, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`poetry/2.3.2 CPython/3.14.3 Darwin/25.5.0`