markdown-table-fixer 0.1.0__tar.gz

markdown_table_fixer-0.1.0/.gitignore

@@ -0,0 +1,66 @@
+# SPDX-License-Identifier: Apache-2.0
+# SPDX-FileCopyrightText: 2025 The Linux Foundation
+
+# Temporary and binary files
+*~
+*.py[cod]
+*.so
+*.cfg
+!.isort.cfg
+!setup.cfg
+*.orig
+*.log
+*.pot
+__pycache__/*
+.cache/*
+.*.swp
+*/.ipynb_checkpoints/*
+.DS_Store
+
+# Project files
+.ropeproject
+.project
+.pydevproject
+.settings
+.idea
+.vscode
+tags
+
+# Package files
+*.egg
+*.eggs/
+.installed.cfg
+*.egg-info
+
+# Unittest and coverage
+htmlcov/*
+.coverage
+.coverage.*
+.tox
+junit*.xml
+coverage.xml
+.pytest_cache/
+
+# Build and docs folder/files
+build/*
+dist/*
+sdist/*
+docs/api/*
+docs/_rst/*
+docs/_build/*
+cover/*
+MANIFEST
+
+# Per-project virtualenvs
+.venv*/
+.conda*/
+.python-version
+
+# Node
+node_modules/*
+
+# Auto-generated version file (generated by setuptools-scm/hatch)
+src/markdown_table_fixer/_version.py
+
+# Test output directory (created by integration tests)
+test_output/

markdown_table_fixer-0.1.0/.pre-commit-hooks.yaml

@@ -0,0 +1,25 @@
+---
+# SPDX-License-Identifier: Apache-2.0
+# SPDX-FileCopyrightText: 2025 The Linux Foundation
+
+- id: markdown-table-fixer
+  name: Markdown Table Fixer
+  description: Fix markdown table formatting issues
+  entry: markdown-table-fixer
+  language: python
+  files: '\.md$|\.markdown$|\.mdown$|\.mkd$'
+  pass_filenames: false
+  args: [lint, ., --auto-fix]
+  always_run: false
+  require_serial: true
+
+- id: markdown-table-fixer-check
+  name: Markdown Table Fixer (Check Only)
+  description: Check markdown table formatting without fixing
+  entry: markdown-table-fixer
+  language: python
+  files: '\.md$|\.markdown$|\.mdown$|\.mkd$'
+  pass_filenames: false
+  args: [lint, ., --check]
+  always_run: false
+  require_serial: true

markdown_table_fixer-0.1.0/LICENSE

@@ -0,0 +1 @@
+LICENSES/Apache-2.0.txt

markdown_table_fixer-0.1.0/LICENSES/Apache-2.0.txt

@@ -0,0 +1,201 @@
+                                 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, whether in Source or
+      Object form, 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 work, whether in Source or Object
+      form, 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.

markdown_table_fixer-0.1.0/PKG-INFO

@@ -0,0 +1,271 @@
+Metadata-Version: 2.4
+Name: markdown-table-fixer
+Version: 0.1.0
+Summary: Markdown table formatter and linter with GitHub integration
+Project-URL: Homepage, https://github.com/lfit/markdown-table-fixer
+Project-URL: Repository, https://github.com/lfit/markdown-table-fixer.git
+Project-URL: Bug Tracker, https://github.com/lfit/markdown-table-fixer/issues
+Author-email: The Linux Foundation <releng@linuxfoundation.org>
+License: Apache-2.0
+License-File: LICENSE
+Keywords: formatter,github,linter,markdown,pre-commit,table
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+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: Topic :: Software Development :: Quality Assurance
+Classifier: Topic :: Text Processing :: Markup :: Markdown
+Requires-Python: <3.14,>=3.10
+Requires-Dist: aiolimiter>=1.2.0
+Requires-Dist: httpx[http2]>=0.28.0
+Requires-Dist: pydantic>=2.10.3
+Requires-Dist: rich>=13.9.4
+Requires-Dist: tenacity>=9.0.0
+Requires-Dist: typer>=0.15.0
+Requires-Dist: wcwidth>=0.2.13
+Provides-Extra: dev
+Requires-Dist: mypy>=1.13.0; extra == 'dev'
+Requires-Dist: pre-commit>=4.0.1; extra == 'dev'
+Requires-Dist: pytest-asyncio>=0.25.0; extra == 'dev'
+Requires-Dist: pytest-cov>=6.0.0; extra == 'dev'
+Requires-Dist: pytest-mock>=3.14.0; extra == 'dev'
+Requires-Dist: pytest>=8.3.4; extra == 'dev'
+Requires-Dist: ruff>=0.8.4; extra == 'dev'
+Description-Content-Type: text/markdown
+
+<!--
+SPDX-License-Identifier: Apache-2.0
+SPDX-FileCopyrightText: 2025 The Linux Foundation
+-->
+
+# 🛠️ Markdown Table Fixer
+
+A modern Python tool for automatically fixing markdown table formatting
+issues. Works as a standalone CLI tool, pre-commit hook, and can bulk-fix
+tables across GitHub organizations.
+
+## Features
+
+- **Lint Mode**: Scan directories for markdown files with table formatting
+  issues
+- **GitHub Mode**: Automatically fix tables in blocked PRs across an entire
+  GitHub organization
+- **Pre-commit Integration**: Run as a pre-commit hook to enforce table
+  formatting standards
+- **Markdownlint Compatible**: Fixes issues detected by markdownlint's
+  MD060 rule
+- **Parallel Processing**: Efficiently processes repositories and PRs in
+  parallel
+
+## Installation
+
+```bash
+pip install markdown-table-fixer
+```
+
+Or with uv:
+
+```bash
+uv pip install markdown-table-fixer
+```
+
+## Usage
+
+### Lint Mode
+
+Scan the current directory for markdown table formatting issues:
+
+```bash
+markdown-table-fixer lint
+```
+
+Scan a specific path:
+
+```bash
+markdown-table-fixer lint /path/to/docs
+```
+
+Auto-fix issues found:
+
+```bash
+markdown-table-fixer lint --auto-fix
+```
+
+### GitHub Mode
+
+The `github` command intelligently handles both individual pull requests and
+entire organizations.
+
+#### Fix a Specific Pull Request
+
+Fix markdown tables in a specific pull request by providing the PR URL:
+
+```bash
+markdown-table-fixer github https://github.com/owner/repo/pull/123 --token YOUR_GITHUB_TOKEN
+```
+
+With environment variable for token:
+
+```bash
+export GITHUB_TOKEN=your_token_here
+markdown-table-fixer github https://github.com/owner/repo/pull/123
+```
+
+Dry run to preview changes without applying them:
+
+```bash
+markdown-table-fixer github https://github.com/owner/repo/pull/123 --dry-run
+```
+
+#### Fix PRs Across an Organization
+
+Scan and fix tables in PRs across an entire GitHub organization:
+
+```bash
+markdown-table-fixer github ORG_NAME --token YOUR_GITHUB_TOKEN
+```
+
+Or using an organization URL:
+
+```bash
+markdown-table-fixer github https://github.com/ORG_NAME/
+```
+
+You can also provide the GitHub token via the `GITHUB_TOKEN` environment
+variable:
+
+```bash
+export GITHUB_TOKEN=your_token_here
+markdown-table-fixer github ORG_NAME
+```
+
+### Pre-commit Integration
+
+Add to your `.pre-commit-config.yaml`:
+
+```yaml
+repos:
+  - repo: https://github.com/lfit/markdown-table-fixer
+    rev: v1.0.0
+    hooks:
+      - id: markdown-table-fixer
+        # Automatically fixes issues
+```
+
+Or use the check variant for validation without auto-fixing:
+
+```yaml
+repos:
+  - repo: https://github.com/lfit/markdown-table-fixer
+    rev: v1.0.0
+    hooks:
+      - id: markdown-table-fixer-check
+        # Validates, doesn't fix
+```
+
+Available hooks:
+
+- `markdown-table-fixer`: Automatically fixes table formatting issues
+- `markdown-table-fixer-check`: Checks for issues without fixing (CI mode)
+
+## Table Formatting Rules
+
+The tool enforces the following formatting standards:
+
+1. **Alignment**: All pipe symbols (`|`) must be vertically aligned
+2. **Spacing**: Cell content must have at least one space on each side
+3. **Consistency**: All rows in a table must follow the same formatting
+   style
+
+### Correct Format
+
+<!-- markdownlint-disable MD013 -->
+
+| Name    | Required | Description  |
+| ------- | -------- | ------------ |
+| input   | False    | Action input |
+| verbose | True     | Enable logs  |
+
+<!-- markdownlint-enable MD013 -->
+
+### Incorrect Format (Fixed Automatically)
+
+<!-- markdownlint-disable MD013 -->
+
+```markdown
+| Name    | Required | Description  |
+| ------- | -------- | ------------ |
+| input   | False    | Action input |
+| verbose | True     | Enable logs  |
+```
+
+<!-- markdownlint-enable MD013 -->
+
+## Options
+
+### Lint Command
+
+<!-- markdownlint-disable MD013 -->
+
+| Flag         | Short | Default | Description                     |
+| ------------ | ----- | ------- | ------------------------------- |
+| `--auto-fix` |       | `false` | Automatically fix issues found  |
+| `--format`   |       | `text`  | Output format: text, json       |
+| `--quiet`    | `-q`  | `false` | Suppress output except errors   |
+| `--check`    |       | `false` | Exit with error if issues found |
+
+<!-- markdownlint-enable MD013 -->
+
+### GitHub Command
+
+<!-- markdownlint-disable MD013 -->
+
+| Flag               | Short | Default | Description                         |
+| ------------------ | ----- | ------- | ----------------------------------- |
+| `--token`          | `-t`  | `None`  | GitHub token (or use $GITHUB_TOKEN) |
+| `--threads`        |       | `auto`  | Number of parallel threads          |
+| `--dry-run`        |       | `false` | Preview changes without applying    |
+| `--format`         |       | `table` | Output format: table, json          |
+| `--include-drafts` |       | `false` | Include draft PRs                   |
+
+<!-- markdownlint-enable MD013 -->
+
+## Development
+
+### Setup
+
+```bash
+git clone https://github.com/lfit/markdown-table-fixer.git
+cd markdown-table-fixer
+uv venv
+source .venv/bin/activate
+uv pip install -e ".[dev]"
+```
+
+### Running Tests
+
+```bash
+pytest
+```
+
+### Running Pre-commit Hooks
+
+```bash
+pre-commit install
+pre-commit run --all-files
+```
+
+## License
+
+Apache-2.0
+
+## Contributing
+
+Contributions are welcome! Please see our contributing guidelines for more
+information.