Repository navigation
Add initial Python package for PyPI #117
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,65 @@ | ||
| name: PyPI Publish | ||
|
|
||
| on: | ||
| release: | ||
| types: [published] | ||
| workflow_dispatch: | ||
| inputs: | ||
| version: | ||
| description: Python package version to publish (for example, 0.1.0) | ||
| required: true | ||
| type: string | ||
|
|
||
| permissions: | ||
| contents: read | ||
|
|
||
| jobs: | ||
| publish: | ||
| if: github.event_name == 'workflow_dispatch' || startsWith(github.ref_name, 'python-v') | ||
| runs-on: ubuntu-latest | ||
| environment: | ||
| name: pypi | ||
| url: https://pypi.org/project/minipdf/ | ||
| permissions: | ||
| contents: read | ||
| id-token: write | ||
| defaults: | ||
| run: | ||
| working-directory: minipdf-python | ||
|
|
||
| steps: | ||
| - name: Checkout | ||
| uses: actions/checkout@v4 | ||
|
|
||
| - name: Setup Python | ||
| uses: actions/setup-python@v5 | ||
| with: | ||
| python-version: '3.12' | ||
|
|
||
| - name: Install build tools | ||
| run: python -m pip install build twine | ||
|
|
||
| - name: Validate release version | ||
| shell: bash | ||
| run: | | ||
| if [ "${{ github.event_name }}" = "workflow_dispatch" ]; then | ||
| TAG_VERSION="${{ inputs.version }}" | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🔒 Security & Privacy | 🟠 Major | ⚡ Quick win 🔎 Supported by static analysis🏁 Script executed: #!/bin/bash
set -eu
printf '%s\n' '--- .github/workflows/pypi-publish.yml ---'
cat -n .github/workflows/pypi-publish.yml | sed -n '1,90p'Repository: mini-software/MiniPdf Length of output: 2446 🤖 get_repo_knowledge executed:
Length of output: 1948 🌐 Web query:
💡 Result: In GitHub Actions, using expressions directly within a Citations:
Pass The workflow expands 🧰 Tools🪛 zizmor (1.29.0)[error] 46-46: code injection via template expansion (template-injection): may expand into attacker-controllable code (template-injection) 🤖 Prompt for AI AgentsSource: Linters/SAST tools |
||
| else | ||
| TAG_VERSION="${GITHUB_REF_NAME#python-v}" | ||
| fi | ||
| PACKAGE_VERSION="$(python -c 'import tomllib; print(tomllib.load(open("pyproject.toml", "rb"))["project"]["version"])')" | ||
| if [ -z "$TAG_VERSION" ] || [ "$TAG_VERSION" != "$PACKAGE_VERSION" ]; then | ||
| echo "::error::Release version '$TAG_VERSION' does not match package version '$PACKAGE_VERSION'." | ||
| exit 1 | ||
| fi | ||
|
|
||
| - name: Build distributions | ||
| run: python -m build | ||
|
|
||
| - name: Check distributions | ||
| run: python -m twine check dist/* | ||
|
|
||
| - name: Publish to PyPI | ||
| uses: pypa/gh-action-pypi-publish@release/v1 | ||
| with: | ||
| packages-dir: minipdf-python/dist/ | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,56 @@ | ||
| name: Python CI | ||
|
|
||
| on: | ||
| push: | ||
| branches: [main, master] | ||
| paths: | ||
| - 'minipdf-python/**' | ||
| - '.github/workflows/python-ci.yml' | ||
| pull_request: | ||
| branches: [main, master] | ||
| paths: | ||
| - 'minipdf-python/**' | ||
| - '.github/workflows/python-ci.yml' | ||
|
|
||
| permissions: | ||
| contents: read | ||
|
|
||
| jobs: | ||
| test: | ||
| strategy: | ||
| matrix: | ||
| os: [ubuntu-latest, windows-latest] | ||
| python-version: ['3.10', '3.12', '3.13'] | ||
| runs-on: ${{ matrix.os }} | ||
|
|
||
| steps: | ||
| - name: Checkout | ||
| uses: actions/checkout@v4 | ||
|
|
||
| - name: Setup Python | ||
| uses: actions/setup-python@v5 | ||
| with: | ||
| python-version: ${{ matrix.python-version }} | ||
| cache: pip | ||
| cache-dependency-path: minipdf-python/pyproject.toml | ||
|
|
||
| - name: Install | ||
| run: python -m pip install -e "./minipdf-python[dev]" | ||
|
|
||
| - name: Test | ||
| run: python -m pytest minipdf-python/tests -q | ||
|
|
||
| - name: Lint | ||
| run: python -m ruff check minipdf-python | ||
|
|
||
| - name: Format | ||
| run: python -m ruff format --check minipdf-python | ||
|
|
||
| - name: Type check | ||
| run: python -m mypy minipdf-python/src minipdf-python/tests | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🎯 Functional Correctness | 🟠 Major | ⚡ Quick win 🔎 Supported by static analysis🏁 Script executed: #!/bin/bash
printf '%s\n' '--- workflow ---'
sed -n '1,75p' .github/workflows/python-ci.yml
printf '%s\n' '--- package configuration ---'
sed -n '1,180p' minipdf-python/pyproject.toml
printf '%s\n' '--- root mypy configuration candidates ---'
find . -maxdepth 2 -type f \( -name 'pyproject.toml' -o -name 'mypy.ini' -o -name '.mypy.ini' -o -name 'setup.cfg' \) -printRepository: mini-software/MiniPdf Length of output: 2894 🌐 Web query:
💡 Result: Mypy uses a specific hierarchical process to discover configuration files. By default, mypy searches for a configuration file by starting in the current working directory and walking up the directory tree until it reaches the root of a repository (e.g., a directory containing a.git or.hg folder) or the root of the filesystem [1][2][3]. In each directory along this path, mypy checks for the following configuration files in this specific order of precedence [1][3]: 1. mypy.ini 2..mypy.ini 3. pyproject.toml (containing a [tool.mypy] section) 4. setup.cfg (containing a [mypy] section) If no configuration file is discovered during this upward search, mypy proceeds to check the following default user-level locations in order [1][3]: 1. $XDG_CONFIG_HOME/mypy/config 2. ~/.config/mypy/config 3. ~/.mypy.ini The --config-file command-line flag can be used to explicitly specify a configuration file path [1][4]. This flag holds the highest precedence; if provided, mypy will use the specified file and ignore the default discovery process [1][3]. If --config-file is used with an empty value (e.g., --config-file=), mypy will ignore all configuration files entirely [4][5]. Mypy does not merge multiple configuration files; it selects the first one found based on the precedence rules above [1][3]. Citations:
Run mypy with the package configuration. The command runs from the repository root, but the only 🤖 Prompt for AI Agents |
||
|
|
||
| - name: Build | ||
| run: python -m build minipdf-python | ||
|
|
||
| - name: Check distributions | ||
| run: python -m twine check minipdf-python/dist/* | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,200 @@ | ||
| Apache License | ||
| Version 2.0, January 2004 | ||
| http://www.apache.org/licenses/ | ||
|
|
||
| TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION | ||
|
|
||
| 1. Definitions. | ||
|
|
||
| "License" shall mean the terms and conditions for use, reproduction, | ||
| and distribution as defined by Sections 1 through 9 of this document. | ||
|
|
||
| "Licensor" shall mean the copyright owner or entity authorized by | ||
| the copyright owner that is granting the License. | ||
|
|
||
| "Legal Entity" shall mean the union of the acting entity and all | ||
| other entities that control, are controlled by, or are under common | ||
| control with that entity. For the purposes of this definition, | ||
| "control" means (i) the power, direct or indirect, to cause the | ||
| direction or management of such entity, whether by contract or | ||
| otherwise, or (ii) ownership of fifty percent (50%) or more of the | ||
| outstanding shares, or (iii) beneficial ownership of such entity. | ||
|
|
||
| "You" (or "Your") shall mean an individual or Legal Entity | ||
| exercising permissions granted by this License. | ||
|
|
||
| "Source" form shall mean the preferred form for making modifications, | ||
| including but not limited to software source code, documentation | ||
| source, and configuration files. | ||
|
|
||
| "Object" form shall mean any form resulting from mechanical | ||
| transformation or translation of a Source form, including but | ||
| not limited to compiled object code, generated documentation, | ||
| and conversions to other media types. | ||
|
|
||
| "Work" shall mean the work of authorship made available under | ||
| the License, as indicated by a copyright notice that is included in | ||
| or attached to the work (an example is provided in the Appendix below). | ||
|
|
||
| "Derivative Works" shall mean any form of the Work that is based on | ||
| (or derived from) the Work and for which the editorial revisions, | ||
| annotations, elaborations, or other modifications represent, as a whole, | ||
| an original work of authorship. For the purposes of this License, | ||
| Derivative Works shall not include works that remain separable from, | ||
| or merely link (or bind by name) to the interfaces of, the Work and | ||
| Derivative Works thereof. | ||
|
|
||
| "Contribution" shall mean any work of authorship, including | ||
| the original version of the Work and any modifications or additions | ||
| to that Work or Derivative Works thereof, that is intentionally | ||
| submitted to Licensor for inclusion in the Work by the copyright owner | ||
| or by an individual or Legal Entity authorized to submit on behalf of | ||
| the copyright owner. For the purposes of this definition, "submitted" | ||
| means any form of electronic, verbal, or written communication sent | ||
| to the Licensor or its representatives, including but not limited to | ||
| communication on electronic mailing lists, source code control systems, | ||
| and issue tracking systems that are managed by, or on behalf of, the | ||
| Licensor for the purpose of discussing and improving the Work, but | ||
| excluding communication that is conspicuously marked or otherwise | ||
| designated in writing by the copyright owner as "Not a Contribution." | ||
|
|
||
| "Contributor" shall mean Licensor and any individual or Legal Entity | ||
| on behalf of whom a Contribution has been received by Licensor and | ||
| subsequently incorporated within the Work. | ||
|
|
||
| 2. Grant of Copyright License. Subject to the terms and conditions of | ||
| this License, each Contributor hereby grants to You a perpetual, | ||
| worldwide, non-exclusive, no-charge, royalty-free, irrevocable | ||
| copyright license to reproduce, prepare Derivative Works of, | ||
| publicly display, publicly perform, sublicense, and distribute the | ||
| Work and such Derivative Works in Source or Object form. | ||
|
|
||
| 3. Grant of Patent License. Subject to the terms and conditions of | ||
| this License, each Contributor hereby grants to You a perpetual, | ||
| worldwide, non-exclusive, no-charge, royalty-free, irrevocable | ||
| (except as stated in this section) patent license to make, have made, | ||
| use, offer to sell, sell, import, and otherwise transfer the Work, | ||
| where such license applies only to those patent claims licensable | ||
| by such Contributor that are necessarily infringed by their | ||
| Contribution(s) alone or by combination of their Contribution(s) | ||
| with the Work to which such Contribution(s) was submitted. If You | ||
| institute patent litigation against any entity (including a | ||
| cross-claim or counterclaim in a lawsuit) alleging that the Work | ||
| or a Contribution incorporated within the Work constitutes direct | ||
| or contributory patent infringement, then any patent licenses | ||
| granted to You under this License for that Work shall terminate | ||
| as of the date such litigation is filed. | ||
|
|
||
| 4. Redistribution. You may reproduce and distribute copies of the | ||
| Work or Derivative Works thereof in any medium, with or without | ||
| modifications, and in Source or Object form, provided that You | ||
| meet the following conditions: | ||
|
|
||
| (a) You must give any other recipients of the Work or | ||
| Derivative Works a copy of this License; and | ||
|
|
||
| (b) You must cause any modified files to carry prominent notices | ||
| stating that You changed the files; and | ||
|
|
||
| (c) You must retain, in the Source form of any Derivative Works | ||
| that You distribute, all copyright, patent, trademark, and | ||
| attribution notices from the Source form of the Work, | ||
| excluding those notices that do not pertain to any part of | ||
| the Derivative Works; and | ||
|
|
||
| (d) If the Work includes a "NOTICE" text file as part of its | ||
| distribution, then any Derivative Works that You distribute must | ||
| include a readable copy of the attribution notices contained | ||
| within such NOTICE file, excluding those notices that do not | ||
| pertain to any part of the Derivative Works, in at least one | ||
| of the following places: within a NOTICE text file distributed | ||
| as part of the Derivative Works; within the Source form or | ||
| documentation, if provided along with the Derivative Works; or, | ||
| within a display generated by the Derivative Works, if and | ||
| wherever such third-party notices normally appear. The contents | ||
| of the NOTICE file are for informational purposes only and | ||
| do not modify the License. You may add Your own attribution | ||
| notices within Derivative Works that You distribute, alongside | ||
| or as an addendum to the NOTICE text from the Work, provided | ||
| that such additional attribution notices cannot be construed | ||
| as modifying the License. | ||
|
|
||
| You may add Your own copyright statement to Your modifications and | ||
| may provide additional or different license terms and conditions | ||
| for use, reproduction, or distribution of Your modifications, or | ||
| for any such Derivative Works as a whole, provided Your use, | ||
| reproduction, and distribution of the Work otherwise complies with | ||
| the conditions stated in this License. | ||
|
|
||
| 5. Submission of Contributions. Unless You explicitly state otherwise, | ||
| any Contribution intentionally submitted for inclusion in the Work | ||
| by You to the Licensor shall be under the terms and conditions of | ||
| this License, without any additional terms or conditions. | ||
| Notwithstanding the above, nothing herein shall supersede or modify | ||
| the terms of any separate license agreement you may have executed | ||
| with Licensor regarding such Contributions. | ||
|
|
||
| 6. Trademarks. This License does not grant permission to use the trade | ||
| names, trademarks, service marks, or product names of the Licensor, | ||
| except as required for reasonable and customary use in describing the | ||
| origin of the Work and reproducing the content of the NOTICE file. | ||
|
|
||
| 7. Disclaimer of Warranty. Unless required by applicable law or | ||
| agreed to in writing, Licensor provides the Work (and each | ||
| Contributor provides its Contributions) on an "AS IS" BASIS, | ||
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or | ||
| implied, including, without limitation, any warranties or conditions | ||
| of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A | ||
| PARTICULAR PURPOSE. You are solely responsible for determining the | ||
| appropriateness of using or redistributing the Work and assume any | ||
| risks associated with Your exercise of permissions under this License. | ||
|
|
||
| 8. Limitation of Liability. In no event and under no legal theory, | ||
| whether in tort (including negligence), contract, or otherwise, | ||
| unless required by applicable law (such as deliberate and grossly | ||
| negligent acts) or agreed to in writing, shall any Contributor be | ||
| liable to You for damages, including any direct, indirect, special, | ||
| incidental, or consequential damages of any character arising as a | ||
| result of this License or out of the use or inability to use the | ||
| Work (including but not limited to damages for loss of goodwill, | ||
| work stoppage, computer failure or malfunction, or any and all | ||
| other commercial damages or losses), even if such Contributor | ||
| has been advised of the possibility of such damages. | ||
|
|
||
| 9. Accepting Warranty or Additional Liability. While redistributing | ||
| the Work or Derivative Works thereof, You may choose to offer, | ||
| and charge a fee for, acceptance of support, warranty, indemnity, | ||
| or other liability obligations and/or rights consistent with this | ||
| License. However, in accepting such obligations, You may act only | ||
| on Your own behalf and on Your sole responsibility, not on behalf | ||
| of any other Contributor, and only if You agree to indemnify, | ||
| defend, and hold each Contributor harmless for any liability | ||
| incurred by, or claims asserted against, such Contributor by reason | ||
| of your accepting any such warranty or additional liability. | ||
|
|
||
| END OF TERMS AND CONDITIONS | ||
|
|
||
| APPENDIX: How to apply the Apache License to your work. | ||
|
|
||
| To apply the Apache License to your work, attach the following | ||
| boilerplate notice, with the fields enclosed by brackets "[]" | ||
| replaced with your own identifying information. (Don't include | ||
| the brackets!) The text should be enclosed in the appropriate | ||
| comment syntax for the file format. We also recommend that a | ||
| file or class name and description of purpose be included on the | ||
| same "printed page" as the copyright notice for easier | ||
| identification within third-party archives. | ||
|
|
||
| Copyright [yyyy] [name of copyright owner] | ||
|
|
||
| Licensed under the Apache License, Version 2.0 (the "License"); | ||
| you may not use this file except in compliance with the License. | ||
| You may obtain a copy of the License at | ||
|
|
||
| http://www.apache.org/licenses/LICENSE-2.0 | ||
|
|
||
| Unless required by applicable law or agreed to in writing, software | ||
| distributed under the License is distributed on an "AS IS" BASIS, | ||
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| See the License for the specific language governing permissions and | ||
| limitations under the License. |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,39 @@ | ||
| # MiniPdf for Python | ||
|
|
||
| Experimental pure Python implementation of MiniPdf. The initial release | ||
| converts basic DOCX paragraphs to PDF 1.4 without requiring Microsoft Office, | ||
| LibreOffice, .NET, or Rust at runtime. | ||
|
|
||
| The package requires Python 3.10 or later. XLSX support is planned; PPTX is not | ||
| currently supported. | ||
|
|
||
| ## Install | ||
|
|
||
| ```bash | ||
| pip install minipdf | ||
| ``` | ||
|
|
||
| ## Python API | ||
|
|
||
| ```python | ||
| import minipdf | ||
|
|
||
| minipdf.convert_to_pdf("report.docx", "report.pdf") | ||
| pdf_bytes = minipdf.convert_to_pdf_bytes("report.docx") | ||
| ``` | ||
|
|
||
| ## Command Line | ||
|
|
||
| ```bash | ||
| minipdf report.docx | ||
| minipdf convert report.docx -o report.pdf | ||
| minipdf report.docx --paper-size a4 | ||
| minipdf report.docx --page-width 400 --page-height 500 | ||
| ``` | ||
|
|
||
| ## Initial Scope | ||
|
|
||
| Version 0.1 supports document page geometry, margins, paragraphs, explicit page | ||
| breaks, and basic bold, italic, and font-size run formatting. Text currently | ||
| uses PDF built-in Latin fonts. Tables, images, embedded fonts, CJK/RTL shaping, | ||
| headers, footers, lists, XLSX, and PPTX are not yet supported. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🔒 Security & Privacy | 🟠 Major | ⚡ Quick win
🔎 Supported by static analysis
🏁 Script executed:
Repository: mini-software/MiniPdf
Length of output: 6147
🤖 get_repo_knowledge executed:
get_repo_knowledge mini-software/MiniPdf /tmp/coderabbit-repo-knowledge/mini-software-minipdf-2049b7d3/conventionsLength of output: 1948
🌐 Web query:
GitHub Actions workflow_dispatch selected branch ref actions/checkout default ref documentation💡 Result:
When a GitHub Actions workflow is triggered manually using the workflow_dispatch event, the user can select a specific branch or tag from the GitHub UI [1][2]. The actions/checkout action automatically respects this selection by default [3][4]. Specifically, the behavior of actions/checkout regarding the ref parameter is as follows: 1. Default Behavior: When checking out the repository that triggered the workflow, actions/checkout defaults to the reference (branch, tag, or SHA) that triggered the event [3][4][5]. If you select a specific branch when manually triggering a workflow_dispatch event, that branch is passed as the reference to the workflow, and actions/checkout will check it out automatically [6]. 2. Overriding the Default: If you wish to ensure that a specific branch (such as main or master) is always checked out, regardless of the branch selected in the UI, you must explicitly set the ref parameter in your checkout step [6]: - uses: actions/checkout@v4 with: ref: 'main' 3. Technical Context: The workflow_dispatch event trigger only functions when the workflow file exists on the repository's default branch [7][1][2]. When manually triggered, the selected branch ref is available to the workflow context [1][6]. The checkout action's internal logic uses the workflow context's ref when no ref is provided in the action configuration [5].
Citations:
Require an exact release tag for manual publishing.
The
publishjob runs for everyworkflow_dispatchevent.actions/checkoutchecks out the selected ref. The version check compares onlyinputs.versionwithminipdf-python/pyproject.toml. A manual run from a branch can therefore publish that branch’s package. Restrict manual runs to a matchingpython-v<version>tag, or removeworkflow_dispatch.🤖 Prompt for AI Agents