v0.1.0: PDF-Helper is now an installable package!

Author: MPCodeWriter21

.github/workflows/pypi.yml

@@ -0,0 +1,43 @@
+name: pypi
+
+on:
+  push:
+    branches:
+      - "master"
+
+jobs:
+  build-and-publish:
+    name: build and publish
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@master
+
+      - name: Set up Python
+        uses: actions/setup-python@v2
+        with:
+          python-version: '3.x'
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install uv
+
+      - name: Build
+        run: |
+          uv build
+          pip install dist/*.whl
+          echo "PACKAGE_VERSION=$(pip show pdf-helper | grep '^Version: ' | cut -d ' ' -f 2)" >> $GITHUB_ENV
+
+      - name: check-version
+        uses: KyoriPowered/action-regex-match@v3
+        id: check-version
+        with:
+          text: ${{ env.PACKAGE_VERSION }}
+          regex: '\d+\.\d+\.\d+a\d+'
+
+      - name: Publish
+        uses: pypa/gh-action-pypi-publish@release/v1
+        if: ${{ steps.check-version.outputs.match == '' }}  # If didn't match
+        with:
+          password: ${{ secrets.PYPI_API_TOKEN }}

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2023-2025 CodeWriter21
+Copyright (c) 2023-2026 CodeWriter21
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,8 +1,7 @@
 PDF-Helper
 ==========
 
-A simple python script that helps with doing simple stuff with PDFs. It is going to
-become a simple python package after `main.py` reaches 1000 lines of code.
+A simple python package that helps with doing simple stuff with PDFs.
 
 Features
 --------
@@ -27,103 +26,118 @@ after adding your contribution.
 Usage
 -----
 
-### Install requirements
+### Installation
 
-+ Install Python for your operating system. Visit [python.org](https://python.org)
+You can install PDF-Helper via pip:
 
-+ Clone the repo:
+```bash
+pip install pdf-helper
+
+# Or use uv to install the tool
+uv tool install pdf-helper
+```
+
+And run it using the command line:
+
+```bash
+pdf-helper <command> [options]
+```
+
+Or you can use uvx to run the package without installing it in a specific python environment:
 
 ```bash
-git clone https://GitHub.com/MPCodeWriter21/PDF-Helper
+uvx pdf-helper <command> [options]
 ```
 
-+ Use pip to install the dependencies:
+You can also clone the repository and use `uv run`:
 
 ```bash
-pip install -r requirements.txt
+git clone https://github.com/MPCodeWriter21/PDF-Helper.git
+cd PDF-Helper
+uv run pdf-helper <command> [options]
 ```
 
 ### Merge PDFs
 
 Merge multiple PDFs into one PDF:
 
 ```bash
-python3 main.py merge -i <input_file_1> <input_file_2>... <input_file_n> -o <output_file>
+pdf-helper merge -i <input_file_1> <input_file_2>... <input_file_n> -o <output_file>
 
 # E.g. Merge PDFs 1, 2 and 3 into a new PDF
-python3 main.py merge -i 1.pdf 2.pdf 3.pdf -o new.pdf
+pdf-helper merge -i 1.pdf 2.pdf 3.pdf -o new.pdf
 ```
 
 ### Split PDFs
 
 Split a PDF into multiple PDFs, each containing a range of pages:
 
 ```bash
-python3 main.py split -i <input_file> -o <output_folder> -s <split_point_1>,<split_point_2>
+pdf-helper split -i <input_file> -o <output_folder> -s <split_point_1>,<split_point_2>
 
 # E.g. Split a PDF into three PDFs, one with pages 1-10, the second with pages 11-20 and
 # the third with pages 21-end
-python3 main.py split -i my-pdf.pdf -o my-split-pdfs -s 10,20
+pdf-helper split -i my-pdf.pdf -o my-split-pdfs -s 10,20
 
 # E.g. Split a PDF into PDFs each containing one page
-python3 main.py split -i my-pdf.pdf -o my-split-pdfs  # No need to specify split points
+pdf-helper split -i my-pdf.pdf -o my-split-pdfs  # No need to specify split points
 ```
 
 ### Export PDF pages as image files
 
 Export PDF pages as image files:
 
 ```bash
-python3 main.py to-image -i <input_file> -o <output_folder> \
+pdf-helper to-image -i <input_file> -o <output_folder> \
         -p <page_number_1>,<page_number_2>,...,<page_number_n> -s <scale_factor>
 
 # E.g. Export pages 1, 2, 3 and 6 from a PDF with scale factor 1
-python3 main.py to-image -i 1.pdf -o images -p 1-3,6 -s 1
+pdf-helper to-image -i 1.pdf -o images -p 1-3,6 -s 1
 
 # E.g. Export all pages from a PDF with scale 2
-python3 main.py to-image -i my-pdf.pdf -o my-images
+pdf-helper to-image -i my-pdf.pdf -o my-images
 ```
 
 ### Remove pages from a PDF
 
 Remove pages from a PDF:
 
 ```bash
-python3 main.py remove-pages -i <input_file> -o <output_file> -p <page_number_1>,<page_number_2>,...,<page_number_n>
+pdf-helper remove-pages -i <input_file> -o <output_file> -p <page_number_1>,<page_number_2>,...,<page_number_n>
 
 # E.g. Remove pages 1, 2, 3 and 6 from a PDF
-python3 main.py remove-pages -i 1.pdf -o new.pdf -p 1-3,6
+pdf-helper remove-pages -i 1.pdf -o new.pdf -p 1-3,6
 ```
 
 ### Export text from a PDF
 
 To extract text from a PDF file and export them to text files you can do as follows:
 
 ```bash
-python3 main.py extract-text -i <input_file> -o <output_file_name>
+pdf-helper extract-text -i <input_file> -o <output_file_name>
 
 # E.g. Extract text from a PDF named my-pdf.pdf and save it to my-text.txt
-python3 main.py extract-text -i my-pdf.pdf -o my-text.txt
+pdf-helper extract-text -i my-pdf.pdf -o my-text.txt
 ```
 
 ### Export one or multiple images as a PDF file
 
 You simply provide the script with your images, and it will create a PDF file with them:
 
 ```bash
-python3 main.py image-to-pdf -i <image_1> <image_2> <image_3> ... -o <output_file>
+pdf-helper image-to-pdf -i <image_1> <image_2> <image_3> ... -o <output_file>
 
 # E.g. Take 1.png, 2.jpg, and 3.png and create a PDF named 123.pdf and override
 # if already exists
-python3 main.py image-to-pdf -i 1.png 2.jpg 3.png -o 123.pdf -f
+pdf-helper image-to-pdf -i 1.png 2.jpg 3.png -o 123.pdf -f
 ```
 
 About
 -----
 
 Author: [CodeWriter21](https://github.com/MPCodeWriter21)
 
-GitHub: [MPCodeWriter21/PDF-To-Image](https://github.com/MPCodeWriter21/PDF-To-Image)
+GitHub: [MPCodeWriter21/PDF-Helper](https://github.com/MPCodeWriter21/PDF-Helper)
 
 Donations
 ---------

pyproject.toml

@@ -1,26 +1,25 @@
 [project]
 name = "PDF-Helper"
+version = "0.1.0"
 authors = [
   {name = "CodeWriter21(Mehrad Pooryoussof)", email = "CodeWriter21@gmail.com"}
 ]
 description = "A simple python script that helps with doing simple stuff with PDFs."
 readme = {file = "README.md", content-type = "text/markdown"}
-requires-python = ">=3.8"
-license = {text = "MIT"}
-
-[tool.pylint.messages_control]
-max-line-length = 88
-
-disable = [
-  "too-few-public-methods",
-  "too-many-arguments",
-  "protected-access",
-  "too-many-locals",
-  "fixme",
+license = {text = "MIT", file = "LICENSE"}
+requires-python = ">=3.9"
+dependencies = [
+    "log21>=3.0.0",
+    "pypdfium2>=4.30.0",
+    "Pillow>=11.0.0"
 ]
 
-[tool.pylint.design]
-max-returns = 8
+[project.scripts]
+pdf-helper = "pdf_helper:__main__.main"
+
+[build-system]
+requires = ["uv_build>=0.8.22,<0.9.0"]
+build-backend = "uv_build"
 
 [tool.yapf]
 column_limit = 88
@@ -42,8 +41,8 @@ wrap-descriptions = 88
 [tool.ruff]
 show-fixes = true
 exclude = ["migrations"]
-target-version = "py38"
+target-version = "py39"
 line-length = 88
 
 [tool.ruff.lint]
-extend-select = ["C4", "SIM", "TCH"]
+extend-select = ["C4", "SIM", "TCH", "ANN", "N", "B"]