feat: Comprehensive Fix - Issues #2, #3, #7, #8, #9, #10 by ambicuity · Pull Request #11 · SUPAIDEAS/passifypdf

ambicuity · 2026-01-24T00:28:36Z

Resolved Issues:

[UNIT TEST]Add couple of unit tests for the funtion encrypt_pdf() #2: Added unit tests for encrypt_pdf.
- [CLI]Develop CLI options for running and creating password protected PDFs #3: Added console_scripts entry point.
- [CI] - Setup a CI build for this python project using GitHub Actions #7: Setup GitHub Actions CI.
- Add Python CI workflow for testing and coverage #8: Python CI workflow.
- Create a doc page for CLI options from Issue No #3 #9: CLI documentation.
- Enabled poetry for the CI build #10: Migrated to Poetry.
  All changes verified locally.

…, SUPAIDEAS#9 - Add CI, Unit Tests, CLI Entry Point, and Docs

…ility

ambicuity · 2026-01-24T00:34:24Z

Pushed a fix (7d58f57) to resolve the CI ModuleNotFoundError. Updated unit tests to use full package imports (passifypdf.encryptpdf) compatible with the Poetry environment.

Copilot

Pull request overview

This PR addresses multiple issues (#2, #3, #7, #8, #9, #10) to add comprehensive functionality including unit tests for the encrypt_pdf function, CLI entry points, GitHub Actions CI workflow, CLI documentation, and migration from setup.py to Poetry-based dependency management.

Changes:

Added unit tests for the encrypt_pdf function with mocking of PdfReader and PdfWriter
Migrated from setup.py and requirements.txt to Poetry (pyproject.toml and poetry.lock)
Created GitHub Actions CI workflow to run tests across Python 3.8-3.12 with coverage reporting
Added CLI documentation describing command-line options

Reviewed changes

Copilot reviewed 8 out of 10 changed files in this pull request and generated 8 comments.

Show a summary per file

File	Description
tests/unittests/test_encryptpdf.py	Added comprehensive unit tests for encrypt_pdf function with mocking; fixed deprecated assertEquals to assertEqual
tests/test_encryptpdf_example.py	Fixed deprecated assertEquals to assertEqual
tests/integrationtests/test_encryptpdf_integration.py	Fixed deprecated assertEquals to assertEqual and updated test value
setup.py	Removed legacy setup.py file as part of Poetry migration
requirements.txt	Removed legacy requirements.txt file as part of Poetry migration
pyproject.toml	Added Poetry configuration with package metadata, dependencies, and console_scripts entry point
poetry.lock	Added Poetry lock file for dependency management
docs/CLI_OPTIONS.md	Added comprehensive CLI documentation with option descriptions and usage example
README.md	Added reference to CLI Options documentation
.github/workflows/ci.yml	Added GitHub Actions CI workflow for testing across multiple Python versions with coverage

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-01-24T00:34:44Z

-
-from encryptpdf import pipeline
+from unittest.mock import patch, mock_open
+from passifypdf.encryptpdf import pipeline, encrypt_pdf


The import statement from encryptpdf import pipeline, encrypt_pdf assumes the module is available at the top level. However, with the Poetry configuration in pyproject.toml defining packages as [{include = "passifypdf"}], this should be from passifypdf.encryptpdf import pipeline, encrypt_pdf. This import will fail when tests are run through Poetry or when the package is properly installed.

Copilot · 2026-01-24T00:34:44Z

+## Example Usage
+
+```bash
+python3 passifypdf/encryptpdf.py -i input.pdf -o protected.pdf -p mySecretPassword


The example usage shows python3 passifypdf/encryptpdf.py -i input.pdf -o protected.pdf -p mySecretPassword, but with the Poetry setup and the console_scripts entry point defined in pyproject.toml (line 21), the correct usage should be passifypdf -i input.pdf -o protected.pdf -p mySecretPassword (after installation with Poetry). The current example doesn't align with how the package is intended to be used via the CLI entry point.

Suggested change

python3 passifypdf/encryptpdf.py -i input.pdf -o protected.pdf -p mySecretPassword

passifypdf -i input.pdf -o protected.pdf -p mySecretPassword

Copilot · 2026-01-24T00:34:45Z


 ## Usage via CLI:

+See [CLI Options](docs/CLI_OPTIONS.md) for full documentation.


The documentation reference to CLI Options is helpful. However, note that the section above (lines 19-23) still references pip install -r requirements.txt, but requirements.txt has been removed in this PR. The installation instructions should be updated to use Poetry commands like poetry install.

Copilot · 2026-01-24T00:34:45Z

+[tool.poetry.scripts]
+passifypdf = "passifypdf.encryptpdf:main"


The console script entry point references passifypdf.encryptpdf:main, which is correct. However, the encryptpdf.py module (not modified in this PR) has an import statement from cli import get_arg_parser which should be from passifypdf.cli import get_arg_parser or from .cli import get_arg_parser. This will cause the CLI to fail when invoked via the entry point. This needs to be addressed for the CLI to work properly.

Copilot · 2026-01-24T00:34:45Z

+    @patch('passifypdf.encryptpdf.PdfReader')
+    @patch('passifypdf.encryptpdf.PdfWriter')


The mock patches reference encryptpdf.PdfReader and encryptpdf.PdfWriter, but with the Poetry package structure, these should be passifypdf.encryptpdf.PdfReader and passifypdf.encryptpdf.PdfWriter to correctly patch the imports within the module.

Copilot · 2026-01-24T00:34:45Z

+
+[tool.poetry.dependencies]
+python = "^3.8"
+pypdf = "4.3.1"


The pypdf dependency is pinned to an exact version 4.3.1 without using a caret (^). This is overly restrictive and prevents Poetry from installing compatible patch or minor updates. Consider using pypdf = "^4.3.1" to allow compatible updates, or at minimum pypdf = "~4.3.1" to allow patch updates, following standard Poetry practices.

Suggested change

pypdf = "4.3.1"

pypdf = "^4.3.1"

Copilot · 2026-01-24T00:34:46Z

+        poetry install
+    - name: Test with unittest
+      run: |
+        poetry run coverage run -m unittest discover tests


The CI workflow will fail when it tries to run the tests because of the incorrect import statements in the test files (see comments on test files). The tests import from encryptpdf instead of passifypdf.encryptpdf, which will cause ImportError when run through Poetry. This needs to be fixed before the CI can pass.

Suggested change

poetry run coverage run -m unittest discover tests

PYTHONPATH=passifypdf poetry run coverage run -m unittest discover tests

Copilot · 2026-01-24T00:34:46Z

+| `-p` | `--passwd` | Yes | Password to use for encryption. |
+| `-v` | `--version` | No | Show the program's version number and exit. |
+| `-h` | `--help` | No | Show the help message and exit. |
+
+## Example Usage
+
+```bash
+python3 passifypdf/encryptpdf.py -i input.pdf -o protected.pdf -p mySecretPassword


The CLI option -p/--passwd encourages passing the PDF encryption password directly on the command line, which exposes the password in process listings (e.g., ps) and in shell history on most systems. An attacker with local access can read these arguments to recover the password and decrypt protected PDFs or reuse the password elsewhere. Consider switching to a safer input method for the password (for example, prompting securely or reading from a protected source) and avoid requiring or documenting plaintext passwords in CLI arguments.

Suggested change

| `-p` | `--passwd` | Yes | Password to use for encryption. |

| `-v` | `--version` | No | Show the program's version number and exit. |

| `-h` | `--help` | No | Show the help message and exit. |

## Example Usage

```bash

python3 passifypdf/encryptpdf.py -i input.pdf -o protected.pdf -p mySecretPassword

| `-p` | `--passwd` | Yes | Password to use for encryption. **Avoid passing sensitive passwords directly on the command line, as they may be exposed via process listings and shell history.** |

| `-v` | `--version` | No | Show the program's version number and exit. |

| `-h` | `--help` | No | Show the help message and exit. |

## Example Usage

```bash

# Prefer providing the password via a secure prompt or protected source (for example, an environment variable).

PDF_PASSWORD='example-password' python3 passifypdf/encryptpdf.py -i input.pdf -o protected.pdf -p "$PDF_PASSWORD"

ambicuity · 2026-01-24T00:39:38Z

Addresses all code review feedback (Commit 5690157):

Fixed encryptpdf.py runtime import error (changed from cli to from .cli).
Updated pyproject.toml to relax pypdf version constraint.
Updated README.md to reference Poetry installation instructions.
Updated docs/CLI_OPTIONS.md with correct entry point usage and security warning.
CI and CLI verified locally.

…teps

nirmalchandra · 2026-01-26T16:58:46Z

Hi @ambicuity , thanks for the PR. CI looks Green now.
Can you check/review the CoPilot suggested changes ? Most of it looks like good ones, worth accepting it(make sure the tests run fine and CI goes Green after that :) ). Thanks for understanding.
Once done, we should eb able to merge.

…and Copilot review Implemented robust error handling in encryptpdf.py. Updated CLI with type hints and return codes. comprehensive unit and integration tests. Addressed all Copilot feedback regarding imports and docs.

- Reorder imports in encryptpdf.py to follow PEP 8 (stdlib → third-party → local) - Fix passifypdf/__init__.py placeholder text from cookiecutter template - Fix unclosed code fence and inline security warning in docs/CLI_OPTIONS.md - Update README.md stale 'Sample Run' section to use Poetry CLI entry point - Clean up blank lines in integration test file - All 8 Copilot suggestions now fully addressed - All tests pass (pytest + unittest)

ambicuity added 2 commits January 23, 2026 18:16

feat: Address Issues SUPAIDEAS#2, SUPAIDEAS#3, SUPAIDEAS#7, SUPAIDEAS#8…

31ad8c9

…, SUPAIDEAS#9 - Add CI, Unit Tests, CLI Entry Point, and Docs

feat: Address Issue SUPAIDEAS#10 - Migrate to Poetry

8c8679a

Copilot AI review requested due to automatic review settings January 24, 2026 00:28

Copilot started reviewing on behalf of ambicuity January 24, 2026 00:28 View session

fix: Update test imports to use full package path for Poetry compatib…

7d58f57

…ility

Copilot AI reviewed Jan 24, 2026

View reviewed changes

fix: Address code review feedback (relative imports, docs, deps)

5690157

ambicuity added 3 commits January 23, 2026 18:44

ci: Add debug steps to investigate Python 3.11 failure

9712d0c

Merge remote-tracking branch 'upstream/main'

5a3aec9

ci: Remove legacy upstream workflow python-ci.yml and cleanup debug s…

81135f7

…teps

ambicuity added 2 commits February 8, 2026 11:38

nirmalchandra approved these changes Feb 19, 2026

View reviewed changes

nirmalchandra merged commit 5a043dd into SUPAIDEAS:main Feb 19, 2026
5 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Comprehensive Fix - Issues #2, #3, #7, #8, #9, #10#11

feat: Comprehensive Fix - Issues #2, #3, #7, #8, #9, #10#11
nirmalchandra merged 9 commits into
SUPAIDEAS:mainfrom
ambicuity:main

ambicuity commented Jan 24, 2026

Uh oh!

ambicuity commented Jan 24, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Jan 24, 2026

Uh oh!

Copilot AI Jan 24, 2026

Uh oh!

Copilot AI Jan 24, 2026

Uh oh!

Copilot AI Jan 24, 2026

Uh oh!

Copilot AI Jan 24, 2026

Uh oh!

Copilot AI Jan 24, 2026

Uh oh!

Copilot AI Jan 24, 2026

Uh oh!

Copilot AI Jan 24, 2026

Uh oh!

ambicuity commented Jan 24, 2026

Uh oh!

nirmalchandra commented Jan 26, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

	python3 passifypdf/encryptpdf.py -i input.pdf -o protected.pdf -p mySecretPassword
	passifypdf -i input.pdf -o protected.pdf -p mySecretPassword


		## Usage via CLI:

		See [CLI Options](docs/CLI_OPTIONS.md) for full documentation.

		[tool.poetry.scripts]
		passifypdf = "passifypdf.encryptpdf:main"

		@patch('passifypdf.encryptpdf.PdfReader')
		@patch('passifypdf.encryptpdf.PdfWriter')

	poetry run coverage run -m unittest discover tests
	PYTHONPATH=passifypdf poetry run coverage run -m unittest discover tests

Conversation

ambicuity commented Jan 24, 2026

Uh oh!

ambicuity commented Jan 24, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Jan 24, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 24, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 24, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 24, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 24, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 24, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 24, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 24, 2026

Choose a reason for hiding this comment

Uh oh!

ambicuity commented Jan 24, 2026

Uh oh!

nirmalchandra commented Jan 26, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants