MAINT: Rename cpdf to pdfly (#14)

Closes #12

Author: MartinThoma

.github/workflows/github-ci.yaml

@@ -32,7 +32,7 @@ jobs:
       run: |
         pip install -r requirements/ci.txt
 
-    - name: Install cpdf
+    - name: Install pdfly
       run: |
         pip install .
 

README.md

@@ -1,27 +1,27 @@
 [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
-[![PyPI version](https://badge.fury.io/py/cpdf.svg)](https://pypi.org/project/cpdf/)
-[![GitHub last commit](https://img.shields.io/github/last-commit/py-pdf/cpdf)](https://github.com/py-pdf/cpdf)
-[![Python Support](https://img.shields.io/pypi/pyversions/cpdf.svg)](https://pypi.org/project/cpdf/)
+[![PyPI version](https://badge.fury.io/py/pdfly.svg)](https://pypi.org/project/pdfly/)
+[![GitHub last commit](https://img.shields.io/github/last-commit/py-pdf/pdfly)](https://github.com/py-pdf/pdfly)
+[![Python Support](https://img.shields.io/pypi/pyversions/pdfly.svg)](https://pypi.org/project/pdfly/)
 
-# cpdf
+# pdfly
 
-cpdf is a pure-python cli application for manipulating PDF files.
+pdfly (say: PDF-li) is a pure-python cli application for manipulating PDF files.
 
 ## Installation
 
 ```bash
-pip install -U cpdf
+pip install -U pdfly
 ```
 
-As `cpdf` is an application, you might want to install it with [`pipx`](https://pypi.org/project/pipx/).
+As `pdfly` is an application, you might want to install it with [`pipx`](https://pypi.org/project/pipx/).
 
 ## Usage
 
 ```console
-$ cpdf --help
-Usage: cpdf [OPTIONS] COMMAND [ARGS]...
+$ pdfly --help
+Usage: pdfly [OPTIONS] COMMAND [ARGS]...
 
-  cpdf is a pure-python cli application for manipulating PDF files.
+  pdfly is a pure-python cli application for manipulating PDF files.
 
 Options:
   --version
@@ -40,8 +40,8 @@ Commands:
 You can see the help of every subcommand by typing:
 
 ```console
-$ cpdf 2-up --help
-Usage: cpdf 2-up [OPTIONS] PDF OUT
+$ pdfly 2-up --help
+Usage: pdfly 2-up [OPTIONS] PDF OUT
 
   Create a booklet-style PDF from a single input.
 

cpdf/__main__.py

@@ -0,0 +1,6 @@
+"""Execute pdfly as a module."""
+
+from pdfly.cli import entry_point
+
+if __name__ == "__main__":
+    entry_point()

cpdf/__init__.py pdfly/__init__.py

@@ -3,22 +3,22 @@
 
 import typer
 
-import cpdf.cat
-import cpdf.compress
-import cpdf.extract_images
-import cpdf.metadata
-import cpdf.up2
+import pdfly.cat
+import pdfly.compress
+import pdfly.extract_images
+import pdfly.metadata
+import pdfly.up2
 
 
 def version_callback(value: bool) -> None:
     if value:
-        typer.echo(f"cpdf {cpdf.__version__}")
+        typer.echo(f"pdfly {pdfly.__version__}")
         raise typer.Exit()
 
 
 entry_point = typer.Typer(
     add_completion=False,
-    help=("cpdf is a pure-python cli application for manipulating PDF files."),
+    help=("pdfly is a pure-python cli application for manipulating PDF files."),
 )
 
 
@@ -32,12 +32,12 @@ def common(
 
 @entry_point.command(name="extract-images")  # type: ignore[misc]
 def extract_images(pdf: Path) -> None:
-    cpdf.extract_images.main(pdf)
+    pdfly.extract_images.main(pdf)
 
 
 @entry_point.command(name="2-up")  # type: ignore[misc]
 def up2(pdf: Path, out: Path) -> None:
-    cpdf.up2.main(pdf, out)
+    pdfly.up2.main(pdf, out)
 
 
 @entry_point.command(name="cat")  # type: ignore[misc]
@@ -51,21 +51,21 @@ def cat(
         False, help="show page ranges as they are being read"
     ),
 ) -> None:
-    cpdf.cat.main(filename, fn_pgrgs, output, verbose)
+    pdfly.cat.main(filename, fn_pgrgs, output, verbose)
 
 
 @entry_point.command(name="meta")  # type: ignore[misc]
 def metadata(
     pdf: Path,
-    output: cpdf.metadata.OutputOptions = typer.Option(  # noqa
-        cpdf.metadata.OutputOptions.text.value,
+    output: pdfly.metadata.OutputOptions = typer.Option(  # noqa
+        pdfly.metadata.OutputOptions.text.value,
         "--output",
         "-o",
         help="output format",
         show_default=True,
     ),
 ) -> None:
-    cpdf.metadata.main(pdf, output)
+    pdfly.metadata.main(pdf, output)
 
 
 @entry_point.command(name="extract-text")  # type: ignore[misc]
@@ -80,11 +80,11 @@ def extract_text(pdf: Path):
 
 @entry_point.command(name="compress")  # type: ignore[misc]
 def compress(pdf: Path, output: Path):
-    cpdf.compress.main(pdf, output)
+    pdfly.compress.main(pdf, output)
 
 
-up2.__doc__ = cpdf.up2.__doc__
-extract_images.__doc__ = cpdf.extract_images.__doc__
-cat.__doc__ = cpdf.cat.__doc__
-metadata.__doc__ = cpdf.metadata.__doc__
-compress.__doc__ = cpdf.compress.__doc__
+up2.__doc__ = pdfly.up2.__doc__
+extract_images.__doc__ = pdfly.extract_images.__doc__
+cat.__doc__ = pdfly.cat.__doc__
+metadata.__doc__ = pdfly.metadata.__doc__
+compress.__doc__ = pdfly.compress.__doc__

pdfly/__main__.py

@@ -1,6 +1,6 @@
 [metadata]
 # https://setuptools.readthedocs.io/en/latest/setuptools.html#configuring-setup-using-setup-cfg-files
-name = cpdf
+name = pdfly
 
 author = Martin Thoma
 author_email = [email protected]
@@ -12,7 +12,7 @@ long_description = file: README.md
 long_description_content_type = text/markdown
 keywords = pdf, pure-python
 
-url = https://github.com/py-pdf/cpdf
+url = https://github.com/py-pdf/pdfly
 license = BSD-3-Clause
 license_file = LICENSE
 
@@ -42,7 +42,7 @@ install_requires =
 
 [options.entry_points]
 console_scripts =
-    cpdf = cpdf.cli:entry_point
+    pdfly = pdfly.cli:entry_point
 
 [tool:pytest]
 addopts = --doctest-modules --cov=. --cov-report html:tests/reports/coverage-html --cov-report term-missing --ignore=docs/ --durations=3 --timeout=30

cpdf/_version.py pdfly/_version.py

@@ -4,7 +4,7 @@
 
 from setuptools import find_packages, setup
 
-VERSIONFILE = "cpdf/_version.py"
+VERSIONFILE = "pdfly/_version.py"
 with open(VERSIONFILE) as fp:
     verstrline = fp.read()
 VSRE = r"^__version__ = ['\"]([^'\"]*)['\"]"