python-cath 0.2.0__tar.gz → 0.3.0__tar.gz

{python-cath-0.2.0 → python_cath-0.3.0}/PKG-INFO

@@ -1,24 +1,27 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: python-cath
-Version: 0.2.0
+Version: 0.3.0
 Summary: Cat files w/ headers
-Home-page: https://github.com/samesense/python-cath
 License: MIT
+License-File: LICENSE
 Author: samesense
 Author-email: candptea@gmail.com
-Requires-Python: >=3.7,<4.0
+Requires-Python: >=3.10,<4.0
 Classifier: Development Status :: 3 - Alpha
 Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.7
-Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
-Requires-Dist: importlib_metadata (>=1.6.0,<2.0.0); python_version < "3.8"
-Requires-Dist: pre-commit (>=2.5.1,<3.0.0)
-Requires-Dist: rich (>=2.2.2,<3.0.0)
-Requires-Dist: typer[all] (>=0.2.1,<0.3.0)
+Requires-Dist: pre-commit (>=3.0.0,<4.0.0)
+Requires-Dist: rich (>=10.0.0)
+Requires-Dist: typer[all] (>=0.9.0,<0.10.0)
+Project-URL: Homepage, https://github.com/samesense/python-cath
 Project-URL: Repository, https://github.com/samesense/python-cath
 Description-Content-Type: text/markdown
 
@@ -39,116 +42,6 @@ Description-Content-Type: text/markdown
 Cat files w/ headers
 </div>
 
-## Very first steps
-
-### Initial
-
-1. Initialize `git` inside your repo:
-
-```bash
-git init
-```
-
-2. If you don't have `Poetry` installed run:
-
-```bash
-make download-poetry
-```
-
-3. Initialize poetry and install `pre-commit` hooks:
-
-```bash
-make install
-```
-
-4. Upload initial code to GitHub (ensure you've run `make install` to use `pre-commit`):
-
-```bash
-git add .
-git commit -m ":tada: Initial commit"
-git remote add origin https://github.com/samesense/python-cath.git
-git push -u origin master
-```
-
-### Initial setting up
-
-- Set up [Dependabot](https://docs.github.com/en/github/administering-a-repository/enabling-and-disabling-version-updates#enabling-github-dependabot-version-updates) to ensure you have the latest dependencies.
-- Set up [Stale bot](https://github.com/apps/stale) for automatic issue closing.
-
-### Poetry
-
-All manipulations with dependencies are executed through Poetry. If you're new to it, look through [the documentation](https://python-poetry.org/docs/).
-
-<details>
-<summary>Notes about Poetry</summary>
-<p>
-
-Poetry's [commands](https://python-poetry.org/docs/cli/#commands) are very intuitive and easy to learn, like:
-
-- `poetry add numpy`
-- `poetry run pytest`
-- `poetry build`
-- etc
-
-</p>
-</details>
-
-### Building your package
-
-Building a new version of the application contains steps:
-
-- Bump the version of your package `poetry version <version>`. You can pass the new version explicitly, or a rule such as `major`, `minor`, or `patch`. For more details, refer to the [Semantic Versions](https://semver.org/) standard.
-- Make a commit to `GitHub`.
-- Create a `GitHub release`.
-- And... publish 🙂 `poetry publish --build`
-
-## What's next
-
-Well, that's up to you. I can only recommend the packages and articles that helped me.
-
-Packages:
-
-- [`Typer`](https://github.com/tiangolo/typer) is great for creating CLI applications.
-- [`Rich`](https://github.com/willmcgugan/rich) makes it easy to add beautiful formatting in the terminal.
-- [`FastAPI`](https://github.com/tiangolo/fastapi) is a type-driven asynchronous web framework.
-- [`IceCream`](https://github.com/gruns/icecream) is a little library for sweet and creamy debugging
-
-Articles:
-
-- [Open Source Guides](https://opensource.guide/)
-- [GitHub Actions Documentation](https://help.github.com/en/actions)
-- Maybe you would like to add [gitmoji](https://gitmoji.carloscuesta.me/) to commit names. This is really funny. 😄
-
-## 🚀 Features
-
-For your development we've prepared:
-
-- Supports for `Python 3.7` and higher.
-- [`Poetry`](https://python-poetry.org/) as the dependencies manager. See configuration in [`pyproject.toml`](https://github.com/samesense/python-cath/blob/master/pyproject.toml) and [`setup.cfg`](https://github.com/samesense/python-cath/blob/master/setup.cfg).
-- Power of [`black`](https://github.com/psf/black), [`isort`](https://github.com/timothycrosley/isort) and [`pyupgrade`](https://github.com/asottile/pyupgrade) formatters.
-- Ready-to-use [`pre-commit`](https://pre-commit.com/) hooks with formatters above.
-- Type checks with the configured [`mypy`](https://mypy.readthedocs.io).
-- Testing with [`pytest`](https://docs.pytest.org/en/latest/).
-- Docstring checks with [`darglint`](https://github.com/terrencepreilly/darglint).
-- Security checks with [`safety`](https://github.com/pyupio/safety) and [`bandit`](https://github.com/PyCQA/bandit).
-- Well-made [`.editorconfig`](https://github.com/samesense/python-cath/blob/master/.editorconfig), [`.dockerignore`](https://github.com/samesense/python-cath/blob/master/.dockerignore), and [`.gitignore`](https://github.com/samesense/python-cath/blob/master/.gitignore). You don't have to worry about those things.
-
-For building and deployment:
-
-- `GitHub` integration.
-- [`Makefile`](https://github.com/samesense/python-cath/blob/master/Makefile#L89) for building routines. Everything is already set up for security checks, codestyle checks, code formatting, testing, linting, docker builds, etc. More details at [Makefile summary](#makefile-usage)).
-- [Dockerfile](https://github.com/samesense/python-cath/blob/master/docker/Dockerfile) for your package.
-- `Github Actions` with predefined [build workflow](https://github.com/samesense/python-cath/blob/master/.github/workflows/build.yml) as the default CI/CD.
-- Always up-to-date dependencies with [`@dependabot`](https://dependabot.com/) (You will only [enable it](https://docs.github.com/en/github/administering-a-repository/enabling-and-disabling-version-updates#enabling-github-dependabot-version-updates)).
-- Automatic drafts of new releases with [`Release Drafter`](https://github.com/marketplace/actions/release-drafter). It creates a list of changes based on labels in merged `Pull Requests`. You can see labels (aka `categories`) in [`release-drafter.yml`](https://github.com/samesense/python-cath/blob/master/.github/release-drafter.yml). Works perfectly with [Semantic Versions](https://semver.org/) specification.
-
-For creating your open source community:
-
-- Ready-to-use [Pull Requests templates](https://github.com/samesense/python-cath/blob/master/.github/PULL_REQUEST_TEMPLATE.md) and several [Issue templates](https://github.com/samesense/python-cath/tree/master/.github/ISSUE_TEMPLATE).
-- Files such as: `LICENSE`, `CONTRIBUTING.md`, `CODE_OF_CONDUCT.md`, and `SECURITY.md` are generated automatically.
-- [`Stale bot`](https://github.com/apps/stale) that closes abandoned issues after a period of inactivity. (You will only [need to setup free plan](https://github.com/marketplace/stale)). Configuration is [here](https://github.com/samesense/python-cath/blob/master/.github/.stale.yml).
-- [Semantic Versions](https://semver.org/) specification with [`Release Drafter`](https://github.com/marketplace/actions/release-drafter).
-
 ## Installation
 
 ```bash
@@ -168,7 +61,7 @@ python-cath --help
 ```
 
 ```bash
-python-cath --name Roman
+python-cath file1 file2 outfile
 ```
 
 or if installed with `Poetry`:
@@ -178,7 +71,7 @@ poetry run python-cath --help
 ```
 
 ```bash
-poetry run python-cath --name Roman
+poetry run python-cath file1 file2 outfile
 ```
 
 ### Makefile usage

{python-cath-0.2.0 → python_cath-0.3.0}/README.md

@@ -15,116 +15,6 @@
 Cat files w/ headers
 </div>
 
-## Very first steps
-
-### Initial
-
-1. Initialize `git` inside your repo:
-
-```bash
-git init
-```
-
-2. If you don't have `Poetry` installed run:
-
-```bash
-make download-poetry
-```
-
-3. Initialize poetry and install `pre-commit` hooks:
-
-```bash
-make install
-```
-
-4. Upload initial code to GitHub (ensure you've run `make install` to use `pre-commit`):
-
-```bash
-git add .
-git commit -m ":tada: Initial commit"
-git remote add origin https://github.com/samesense/python-cath.git
-git push -u origin master
-```
-
-### Initial setting up
-
-- Set up [Dependabot](https://docs.github.com/en/github/administering-a-repository/enabling-and-disabling-version-updates#enabling-github-dependabot-version-updates) to ensure you have the latest dependencies.
-- Set up [Stale bot](https://github.com/apps/stale) for automatic issue closing.
-
-### Poetry
-
-All manipulations with dependencies are executed through Poetry. If you're new to it, look through [the documentation](https://python-poetry.org/docs/).
-
-<details>
-<summary>Notes about Poetry</summary>
-<p>
-
-Poetry's [commands](https://python-poetry.org/docs/cli/#commands) are very intuitive and easy to learn, like:
-
-- `poetry add numpy`
-- `poetry run pytest`
-- `poetry build`
-- etc
-
-</p>
-</details>
-
-### Building your package
-
-Building a new version of the application contains steps:
-
-- Bump the version of your package `poetry version <version>`. You can pass the new version explicitly, or a rule such as `major`, `minor`, or `patch`. For more details, refer to the [Semantic Versions](https://semver.org/) standard.
-- Make a commit to `GitHub`.
-- Create a `GitHub release`.
-- And... publish 🙂 `poetry publish --build`
-
-## What's next
-
-Well, that's up to you. I can only recommend the packages and articles that helped me.
-
-Packages:
-
-- [`Typer`](https://github.com/tiangolo/typer) is great for creating CLI applications.
-- [`Rich`](https://github.com/willmcgugan/rich) makes it easy to add beautiful formatting in the terminal.
-- [`FastAPI`](https://github.com/tiangolo/fastapi) is a type-driven asynchronous web framework.
-- [`IceCream`](https://github.com/gruns/icecream) is a little library for sweet and creamy debugging
-
-Articles:
-
-- [Open Source Guides](https://opensource.guide/)
-- [GitHub Actions Documentation](https://help.github.com/en/actions)
-- Maybe you would like to add [gitmoji](https://gitmoji.carloscuesta.me/) to commit names. This is really funny. 😄
-
-## 🚀 Features
-
-For your development we've prepared:
-
-- Supports for `Python 3.7` and higher.
-- [`Poetry`](https://python-poetry.org/) as the dependencies manager. See configuration in [`pyproject.toml`](https://github.com/samesense/python-cath/blob/master/pyproject.toml) and [`setup.cfg`](https://github.com/samesense/python-cath/blob/master/setup.cfg).
-- Power of [`black`](https://github.com/psf/black), [`isort`](https://github.com/timothycrosley/isort) and [`pyupgrade`](https://github.com/asottile/pyupgrade) formatters.
-- Ready-to-use [`pre-commit`](https://pre-commit.com/) hooks with formatters above.
-- Type checks with the configured [`mypy`](https://mypy.readthedocs.io).
-- Testing with [`pytest`](https://docs.pytest.org/en/latest/).
-- Docstring checks with [`darglint`](https://github.com/terrencepreilly/darglint).
-- Security checks with [`safety`](https://github.com/pyupio/safety) and [`bandit`](https://github.com/PyCQA/bandit).
-- Well-made [`.editorconfig`](https://github.com/samesense/python-cath/blob/master/.editorconfig), [`.dockerignore`](https://github.com/samesense/python-cath/blob/master/.dockerignore), and [`.gitignore`](https://github.com/samesense/python-cath/blob/master/.gitignore). You don't have to worry about those things.
-
-For building and deployment:
-
-- `GitHub` integration.
-- [`Makefile`](https://github.com/samesense/python-cath/blob/master/Makefile#L89) for building routines. Everything is already set up for security checks, codestyle checks, code formatting, testing, linting, docker builds, etc. More details at [Makefile summary](#makefile-usage)).
-- [Dockerfile](https://github.com/samesense/python-cath/blob/master/docker/Dockerfile) for your package.
-- `Github Actions` with predefined [build workflow](https://github.com/samesense/python-cath/blob/master/.github/workflows/build.yml) as the default CI/CD.
-- Always up-to-date dependencies with [`@dependabot`](https://dependabot.com/) (You will only [enable it](https://docs.github.com/en/github/administering-a-repository/enabling-and-disabling-version-updates#enabling-github-dependabot-version-updates)).
-- Automatic drafts of new releases with [`Release Drafter`](https://github.com/marketplace/actions/release-drafter). It creates a list of changes based on labels in merged `Pull Requests`. You can see labels (aka `categories`) in [`release-drafter.yml`](https://github.com/samesense/python-cath/blob/master/.github/release-drafter.yml). Works perfectly with [Semantic Versions](https://semver.org/) specification.
-
-For creating your open source community:
-
-- Ready-to-use [Pull Requests templates](https://github.com/samesense/python-cath/blob/master/.github/PULL_REQUEST_TEMPLATE.md) and several [Issue templates](https://github.com/samesense/python-cath/tree/master/.github/ISSUE_TEMPLATE).
-- Files such as: `LICENSE`, `CONTRIBUTING.md`, `CODE_OF_CONDUCT.md`, and `SECURITY.md` are generated automatically.
-- [`Stale bot`](https://github.com/apps/stale) that closes abandoned issues after a period of inactivity. (You will only [need to setup free plan](https://github.com/marketplace/stale)). Configuration is [here](https://github.com/samesense/python-cath/blob/master/.github/.stale.yml).
-- [Semantic Versions](https://semver.org/) specification with [`Release Drafter`](https://github.com/marketplace/actions/release-drafter).
-
 ## Installation
 
 ```bash
@@ -144,7 +34,7 @@ python-cath --help
 ```
 
 ```bash
-python-cath --name Roman
+python-cath file1 file2 outfile
 ```
 
 or if installed with `Poetry`:
@@ -154,7 +44,7 @@ poetry run python-cath --help
 ```
 
 ```bash
-poetry run python-cath --name Roman
+poetry run python-cath file1 file2 outfile
 ```
 
 ### Makefile usage

{python-cath-0.2.0 → python_cath-0.3.0}/pyproject.toml

@@ -6,7 +6,7 @@ build-backend = "poetry.masonry.api"
 
 [tool.poetry]
 name = "python-cath"
-version = "0.2.0"
+version = "0.3.0"
 description = "Cat files w/ headers"
 readme = "README.md"
 authors = [
@@ -32,28 +32,28 @@ classifiers = [  # Update me
 "python-cath" = "python_cath.__main__:app"
 
 [tool.poetry.dependencies]
-python = "^3.7"
-importlib_metadata = {version = "^1.6.0", python = "<3.8"}
-typer = {extras = ["all"], version = "^0.2.1"}
-rich = "^2.2.2"
-pre-commit = "^2.5.1"
+python = "^3.10"
+typer = {extras = ["all"], version = "^0.9.0"}
+rich = ">=10.0.0"
+pre-commit = "^3.0.0"
 
 [tool.poetry.dev-dependencies]
-darglint = "^1.4.1"
-isort = {extras = ["pyproject"], version = "^4.3.21"}
-pyupgrade = "^2.6.1"
-black = "^19.10b0"
-mypy = "^0.780"
-bandit = "^1.6.2"
-safety = "^1.9.0"
-pytest = "^5.4.3"
-pylint = "^2.5.3"
-pydocstyle = "^5.0.2"
+setuptools = ">=65.0.0"
+darglint = "^1.8.1"
+isort = {extras = ["pyproject"], version = "^5.10.0"}
+pyupgrade = "^3.3.0"
+black = "^24.0.0"
+mypy = "^1.0"
+bandit = "^1.7.0"
+safety = "^2.0.0"
+pytest = "^7.0.0"
+pylint = "^3.0.0"
+pydocstyle = "^6.0.0"
 
 [tool.black]
 # https://github.com/psf/black
 line-length = 80
-target-version = ["py37"]
+target-version = ["py310", "py311", "py312"]
 
 [tool.isort]
 # https://github.com/timothycrosley/isort/

python_cath-0.3.0/python_cath/__init__.py

@@ -0,0 +1,9 @@
+# mypy: disable-error-code="attr-defined"
+"""Cat files w/ headers"""
+
+from importlib.metadata import PackageNotFoundError, version
+
+try:
+    __version__ = version(__name__)
+except PackageNotFoundError:  # pragma: no cover
+    __version__ = "unknown"

python_cath-0.3.0/python_cath/__main__.py

@@ -0,0 +1,33 @@
+# mypy: disable-error-code="attr-defined"
+
+from typing import List
+
+import typer
+from python_cath import __version__
+from python_cath.concat import concat
+from rich.console import Console
+
+app = typer.Typer(
+    name="python-cath",
+    help="Cat files w/ headers",
+    add_completion=False,
+)
+console = Console()
+
+
+def version_callback(value: bool) -> None:
+    """Prints the version of the package."""
+    if value:
+        console.print(
+            f"[yellow]python-cath[/] version: [bold blue]{__version__}[/]"
+        )
+        raise typer.Exit()
+
+
+@app.command()
+def main(
+    file_list: List[str] = typer.Argument(...),
+    output_file: str = typer.Argument(...),
+) -> None:
+    """Concatenate CSV files with a shared header into output_file."""
+    concat(file_list, output_file)

python_cath-0.3.0/python_cath/concat.py

@@ -0,0 +1,49 @@
+import os
+import shutil
+
+
+def concat(file_list, output_file):
+    """Concatenate CSV files that share the same header.
+
+    Args:
+        file_list: Paths to input files.
+        output_file: Path to write the concatenated output.
+
+    Raises:
+        ValueError: If no input files are provided, any file has an empty
+            header, an input file path collides with the output file, or
+            file headers differ.
+    """
+    file_list = list(file_list)
+    if not file_list:
+        raise ValueError("file_list must not be empty")
+
+    real_output = os.path.realpath(output_file)
+    for afile in file_list:
+        if os.path.realpath(afile) == real_output:
+            raise ValueError(
+                f"Input file {afile!r} is the same path as the output file"
+            )
+
+    # First pass: read and validate headers one file at a time
+    file_headers = {}
+    for afile in file_list:
+        with open(afile, encoding="utf-8") as fh:
+            header = fh.readline().rstrip("\n")
+        if not header:
+            raise ValueError(f"File {afile!r} has an empty or missing header")
+        file_headers[afile] = header
+
+    unique_headers = set(file_headers.values())
+    if len(unique_headers) > 1:
+        detail = ", ".join(f"{f!r}: {h!r}" for f, h in file_headers.items())
+        raise ValueError(f"Headers do not match: {detail}")
+
+    # Second pass: write output one file at a time
+    shared_header = next(iter(unique_headers))
+    with open(output_file, "w", encoding="utf-8") as out:
+        out.write(shared_header + "\n")
+        for afile in file_list:
+            with open(afile, encoding="utf-8") as fh:
+                fh.readline()  # skip header
+                shutil.copyfileobj(fh, out)

python-cath-0.2.0/python_cath/__init__.py

@@ -1,13 +0,0 @@
-# type: ignore[attr-defined]
-"""Cat files w/ headers"""
-
-try:
-    from importlib.metadata import version, PackageNotFoundError
-except ImportError:  # pragma: no cover
-    from importlib_metadata import version, PackageNotFoundError
-
-
-try:
-    __version__ = version(__name__)
-except PackageNotFoundError:  # pragma: no cover
-    __version__ = "unknown"

python-cath-0.2.0/python_cath/__main__.py

@@ -1,41 +0,0 @@
-# type: ignore[attr-defined]
-
-import os
-import random
-from enum import Enum
-from typing import List, Optional
-
-import typer
-from rich.console import Console
-
-from python_cath import __version__
-from python_cath.example import hello
-
-app = typer.Typer(
-    name="python-cath", help="Cat files w/ headers", add_completion=False,
-)
-console = Console()
-
-
-def version_callback(value: bool):
-    """Prints the version of the package."""
-    if value:
-        console.print(
-            f"[yellow]python-cath[/] version: [bold blue]{__version__}[/]"
-        )
-        raise typer.Exit()
-
-
-def concat(file_list, output_file):
-    os.system(f"head -1 {file_list[0]} > {output_file}")
-    for afile in file_list:
-        os.system(f"tail -n +2 {afile} >> {output_file}")
-
-
-@app.command()
-def main(
-    file_list: List[str] = typer.Argument(...),
-    output_file: str = typer.Argument(...),
-):
-    """Prints a greeting for a giving name."""
-    concat(file_list, output_file)

python-cath-0.2.0/setup.py

@@ -1,38 +0,0 @@
-# -*- coding: utf-8 -*-
-from setuptools import setup
-
-packages = \
-['python_cath']
-
-package_data = \
-{'': ['*']}
-
-install_requires = \
-['pre-commit>=2.5.1,<3.0.0', 'rich>=2.2.2,<3.0.0', 'typer[all]>=0.2.1,<0.3.0']
-
-extras_require = \
-{':python_version < "3.8"': ['importlib_metadata>=1.6.0,<2.0.0']}
-
-entry_points = \
-{'console_scripts': ['python-cath = python_cath.__main__:app']}
-
-setup_kwargs = {
-    'name': 'python-cath',
-    'version': '0.2.0',
-    'description': 'Cat files w/ headers',
-    'long_description': '# python-cath\n\n<div align="center">\n\n[![Build status](https://github.com/samesense/python-cath/workflows/build/badge.svg?branch=master&event=push)](https://github.com/samesense/python-cath/actions?query=workflow%3Abuild)\n[![Python Version](https://img.shields.io/pypi/pyversions/python-cath.svg)](https://pypi.org/project/python-cath/)\n[![Dependencies Status](https://img.shields.io/badge/dependencies-up%20to%20date-brightgreen.svg)](https://github.com/samesense/python-cath/pulls?utf8=%E2%9C%93&q=is%3Apr%20author%3Aapp%2Fdependabot)\n\n[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)\n[![Security: bandit](https://img.shields.io/badge/security-bandit-green.svg)](https://github.com/PyCQA/bandit)\n[![Pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://github.com/samesense/python-cath/blob/master/.pre-commit-config.yaml)\n[![Semantic Versions](https://img.shields.io/badge/%F0%9F%9A%80-semantic%20versions-informational.svg)](https://github.com/samesense/python-cath/releases)\n[![License](https://img.shields.io/github/license/samesense/python-cath)](https://github.com/samesense/python-cath/blob/master/LICENSE)\n\nCat files w/ headers\n</div>\n\n## Very first steps\n\n### Initial\n\n1. Initialize `git` inside your repo:\n\n```bash\ngit init\n```\n\n2. If you don\'t have `Poetry` installed run:\n\n```bash\nmake download-poetry\n```\n\n3. Initialize poetry and install `pre-commit` hooks:\n\n```bash\nmake install\n```\n\n4. Upload initial code to GitHub (ensure you\'ve run `make install` to use `pre-commit`):\n\n```bash\ngit add .\ngit commit -m ":tada: Initial commit"\ngit remote add origin https://github.com/samesense/python-cath.git\ngit push -u origin master\n```\n\n### Initial setting up\n\n- Set up [Dependabot](https://docs.github.com/en/github/administering-a-repository/enabling-and-disabling-version-updates#enabling-github-dependabot-version-updates) to ensure you have the latest dependencies.\n- Set up [Stale bot](https://github.com/apps/stale) for automatic issue closing.\n\n### Poetry\n\nAll manipulations with dependencies are executed through Poetry. If you\'re new to it, look through [the documentation](https://python-poetry.org/docs/).\n\n<details>\n<summary>Notes about Poetry</summary>\n<p>\n\nPoetry\'s [commands](https://python-poetry.org/docs/cli/#commands) are very intuitive and easy to learn, like:\n\n- `poetry add numpy`\n- `poetry run pytest`\n- `poetry build`\n- etc\n\n</p>\n</details>\n\n### Building your package\n\nBuilding a new version of the application contains steps:\n\n- Bump the version of your package `poetry version <version>`. You can pass the new version explicitly, or a rule such as `major`, `minor`, or `patch`. For more details, refer to the [Semantic Versions](https://semver.org/) standard.\n- Make a commit to `GitHub`.\n- Create a `GitHub release`.\n- And... publish 🙂 `poetry publish --build`\n\n## What\'s next\n\nWell, that\'s up to you. I can only recommend the packages and articles that helped me.\n\nPackages:\n\n- [`Typer`](https://github.com/tiangolo/typer) is great for creating CLI applications.\n- [`Rich`](https://github.com/willmcgugan/rich) makes it easy to add beautiful formatting in the terminal.\n- [`FastAPI`](https://github.com/tiangolo/fastapi) is a type-driven asynchronous web framework.\n- [`IceCream`](https://github.com/gruns/icecream) is a little library for sweet and creamy debugging\n\nArticles:\n\n- [Open Source Guides](https://opensource.guide/)\n- [GitHub Actions Documentation](https://help.github.com/en/actions)\n- Maybe you would like to add [gitmoji](https://gitmoji.carloscuesta.me/) to commit names. This is really funny. 😄\n\n## 🚀 Features\n\nFor your development we\'ve prepared:\n\n- Supports for `Python 3.7` and higher.\n- [`Poetry`](https://python-poetry.org/) as the dependencies manager. See configuration in [`pyproject.toml`](https://github.com/samesense/python-cath/blob/master/pyproject.toml) and [`setup.cfg`](https://github.com/samesense/python-cath/blob/master/setup.cfg).\n- Power of [`black`](https://github.com/psf/black), [`isort`](https://github.com/timothycrosley/isort) and [`pyupgrade`](https://github.com/asottile/pyupgrade) formatters.\n- Ready-to-use [`pre-commit`](https://pre-commit.com/) hooks with formatters above.\n- Type checks with the configured [`mypy`](https://mypy.readthedocs.io).\n- Testing with [`pytest`](https://docs.pytest.org/en/latest/).\n- Docstring checks with [`darglint`](https://github.com/terrencepreilly/darglint).\n- Security checks with [`safety`](https://github.com/pyupio/safety) and [`bandit`](https://github.com/PyCQA/bandit).\n- Well-made [`.editorconfig`](https://github.com/samesense/python-cath/blob/master/.editorconfig), [`.dockerignore`](https://github.com/samesense/python-cath/blob/master/.dockerignore), and [`.gitignore`](https://github.com/samesense/python-cath/blob/master/.gitignore). You don\'t have to worry about those things.\n\nFor building and deployment:\n\n- `GitHub` integration.\n- [`Makefile`](https://github.com/samesense/python-cath/blob/master/Makefile#L89) for building routines. Everything is already set up for security checks, codestyle checks, code formatting, testing, linting, docker builds, etc. More details at [Makefile summary](#makefile-usage)).\n- [Dockerfile](https://github.com/samesense/python-cath/blob/master/docker/Dockerfile) for your package.\n- `Github Actions` with predefined [build workflow](https://github.com/samesense/python-cath/blob/master/.github/workflows/build.yml) as the default CI/CD.\n- Always up-to-date dependencies with [`@dependabot`](https://dependabot.com/) (You will only [enable it](https://docs.github.com/en/github/administering-a-repository/enabling-and-disabling-version-updates#enabling-github-dependabot-version-updates)).\n- Automatic drafts of new releases with [`Release Drafter`](https://github.com/marketplace/actions/release-drafter). It creates a list of changes based on labels in merged `Pull Requests`. You can see labels (aka `categories`) in [`release-drafter.yml`](https://github.com/samesense/python-cath/blob/master/.github/release-drafter.yml). Works perfectly with [Semantic Versions](https://semver.org/) specification.\n\nFor creating your open source community:\n\n- Ready-to-use [Pull Requests templates](https://github.com/samesense/python-cath/blob/master/.github/PULL_REQUEST_TEMPLATE.md) and several [Issue templates](https://github.com/samesense/python-cath/tree/master/.github/ISSUE_TEMPLATE).\n- Files such as: `LICENSE`, `CONTRIBUTING.md`, `CODE_OF_CONDUCT.md`, and `SECURITY.md` are generated automatically.\n- [`Stale bot`](https://github.com/apps/stale) that closes abandoned issues after a period of inactivity. (You will only [need to setup free plan](https://github.com/marketplace/stale)). Configuration is [here](https://github.com/samesense/python-cath/blob/master/.github/.stale.yml).\n- [Semantic Versions](https://semver.org/) specification with [`Release Drafter`](https://github.com/marketplace/actions/release-drafter).\n\n## Installation\n\n```bash\npip install python-cath\n```\n\nor install with `Poetry`\n\n```bash\npoetry add python-cath\n```\n\nThen you can run\n\n```bash\npython-cath --help\n```\n\n```bash\npython-cath --name Roman\n```\n\nor if installed with `Poetry`:\n\n```bash\npoetry run python-cath --help\n```\n\n```bash\npoetry run python-cath --name Roman\n```\n\n### Makefile usage\n\n[`Makefile`](https://github.com/samesense/python-cath/blob/master/Makefile) contains many functions for fast assembling and convenient work.\n\n<details>\n<summary>1. Download Poetry</summary>\n<p>\n\n```bash\nmake download-poetry\n```\n\n</p>\n</details>\n\n<details>\n<summary>2. Install all dependencies and pre-commit hooks</summary>\n<p>\n\n```bash\nmake install\n```\n\nIf you do not want to install pre-commit hooks, run the command with the NO_PRE_COMMIT flag:\n\n```bash\nmake install NO_PRE_COMMIT=1\n```\n\n</p>\n</details>\n\n<details>\n<summary>3. Check the security of your code</summary>\n<p>\n\n```bash\nmake check-safety\n```\n\nThis 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.\n\n```bash\nmake check-safety STRICT=1\n```\n\nor only for `safety`:\n\n```bash\nmake check-safety SAFETY_STRICT=1\n```\n\nmultiple\n\n```bash\nmake check-safety PIP_STRICT=1 SAFETY_STRICT=1\n```\n\n> List of flags for `check-safety` (can be set to `1` or `0`): `STRICT`, `POETRY_STRICT`, `PIP_STRICT`, `SAFETY_STRICT`, `BANDIT_STRICT`.\n\n</p>\n</details>\n\n<details>\n<summary>4. Check the codestyle</summary>\n<p>\n\nThe command is similar to `check-safety` but to check the code style, obviously. It uses `Black`, `Darglint`, `Isort`, and `Mypy` inside.\n\n```bash\nmake check-style\n```\n\nIt may also contain the `STRICT` flag.\n\n```bash\nmake check-style STRICT=1\n```\n\n> List of flags for `check-style` (can be set to `1` or `0`): `STRICT`, `BLACK_STRICT`, `DARGLINT_STRICT`, `ISORT_STRICT`, `MYPY_STRICT`.\n\n</p>\n</details>\n\n<details>\n<summary>5. Run all the codestyle formaters</summary>\n<p>\n\nCodestyle uses `pre-commit` hooks, so ensure you\'ve run `make install` before.\n\n```bash\nmake codestyle\n```\n\n</p>\n</details>\n\n<details>\n<summary>6. Run tests</summary>\n<p>\n\n```bash\nmake test\n```\n\n</p>\n</details>\n\n<details>\n<summary>7. Run all the linters</summary>\n<p>\n\n```bash\nmake lint\n```\n\nthe same as:\n\n```bash\nmake test && make check-safety && make check-style\n```\n\n> 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`.\n\n</p>\n</details>\n\n<details>\n<summary>8. Build docker</summary>\n<p>\n\n```bash\nmake docker\n```\n\nwhich is equivalent to:\n\n```bash\nmake docker VERSION=latest\n```\n\nMore information [here](https://github.com/samesense/python-cath/tree/master/docker).\n\n</p>\n</details>\n\n<details>\n<summary>9. Cleanup docker</summary>\n<p>\n\n```bash\nmake clean_docker\n```\n\nor to remove all build\n\n```bash\nmake clean\n```\n\nMore information [here](https://github.com/samesense/python-cath/tree/master/docker).\n\n</p>\n</details>\n\n## 📈 Releases\n\nYou can see the list of available releases on the [GitHub Releases](https://github.com/samesense/python-cath/releases) page.\n\nWe follow [Semantic Versions](https://semver.org/) specification.\n\nWe use [`Release Drafter`](https://github.com/marketplace/actions/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.\n\nFor Pull Request this labels are configured, by default:\n\n|               **Label**               |  **Title in Releases**  |\n|:-------------------------------------:|:----------------------:|\n| `enhancement`, `feature`              | 🚀 Features             |\n| `bug`, `refactoring`, `bugfix`, `fix` | 🔧 Fixes & Refactoring  |\n| `build`, `ci`, `testing`              | 📦 Build System & CI/CD |\n| `breaking`                            | 💥 Breaking Changes     |\n| `documentation`                       | 📝 Documentation        |\n| `dependencies`                        | ⬆️ Dependencies updates |\n\nYou can update it in [`release-drafter.yml`](https://github.com/samesense/python-cath/blob/master/.github/release-drafter.yml).\n\nGitHub 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.\n\n## 🛡 License\n\n[![License](https://img.shields.io/github/license/samesense/python-cath)](https://github.com/samesense/python-cath/blob/master/LICENSE)\n\nThis project is licensed under the terms of the `MIT` license. See [LICENSE](https://github.com/samesense/python-cath/blob/master/LICENSE) for more details.\n\n## 📃 Citation\n\n```\n@misc{python-cath,\n  author = {samesense},\n  title = {Cat files w/ headers},\n  year = {2020},\n  publisher = {GitHub},\n  journal = {GitHub repository},\n  howpublished = {\\url{https://github.com/samesense/python-cath}}\n}\n```\n\n## Credits\n\nThis project was generated with [`python-package-template`](https://github.com/TezRomacH/python-package-template).\n',
-    'author': 'samesense',
-    'author_email': 'candptea@gmail.com',
-    'maintainer': None,
-    'maintainer_email': None,
-    'url': 'https://github.com/samesense/python-cath',
-    'packages': packages,
-    'package_data': package_data,
-    'install_requires': install_requires,
-    'extras_require': extras_require,
-    'entry_points': entry_points,
-    'python_requires': '>=3.7,<4.0',
-}
-
-
-setup(**setup_kwargs)