compatag 0.1.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (32) hide show
  1. compatag-0.1.0/LICENSE +21 -0
  2. compatag-0.1.0/PKG-INFO +189 -0
  3. compatag-0.1.0/README.md +155 -0
  4. compatag-0.1.0/pyproject.toml +100 -0
  5. compatag-0.1.0/setup.cfg +4 -0
  6. compatag-0.1.0/src/compatag/__init__.py +1 -0
  7. compatag-0.1.0/src/compatag/__main__.py +3 -0
  8. compatag-0.1.0/src/compatag/analyzer.py +736 -0
  9. compatag-0.1.0/src/compatag/audit.py +478 -0
  10. compatag-0.1.0/src/compatag/cli.py +774 -0
  11. compatag-0.1.0/src/compatag/compare.py +500 -0
  12. compatag-0.1.0/src/compatag/distributions.py +50 -0
  13. compatag-0.1.0/src/compatag/limits.py +59 -0
  14. compatag-0.1.0/src/compatag/manifests.py +945 -0
  15. compatag-0.1.0/src/compatag/mcp_server.py +270 -0
  16. compatag-0.1.0/src/compatag/pypi.py +625 -0
  17. compatag-0.1.0/src/compatag/python_compat.py +68 -0
  18. compatag-0.1.0/src/compatag/targets.py +257 -0
  19. compatag-0.1.0/src/compatag.egg-info/PKG-INFO +189 -0
  20. compatag-0.1.0/src/compatag.egg-info/SOURCES.txt +30 -0
  21. compatag-0.1.0/src/compatag.egg-info/dependency_links.txt +1 -0
  22. compatag-0.1.0/src/compatag.egg-info/entry_points.txt +3 -0
  23. compatag-0.1.0/src/compatag.egg-info/requires.txt +13 -0
  24. compatag-0.1.0/src/compatag.egg-info/top_level.txt +1 -0
  25. compatag-0.1.0/tests/test_analyzer.py +675 -0
  26. compatag-0.1.0/tests/test_audit.py +612 -0
  27. compatag-0.1.0/tests/test_cli.py +587 -0
  28. compatag-0.1.0/tests/test_compare.py +600 -0
  29. compatag-0.1.0/tests/test_manifests.py +489 -0
  30. compatag-0.1.0/tests/test_mcp.py +523 -0
  31. compatag-0.1.0/tests/test_pypi.py +519 -0
  32. compatag-0.1.0/tests/test_targets.py +158 -0
compatag-0.1.0/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 Sharnav Mahajan
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
@@ -0,0 +1,189 @@
1
+ Metadata-Version: 2.4
2
+ Name: compatag
3
+ Version: 0.1.0
4
+ Summary: Preflight Python package compatibility across Python versions and platforms.
5
+ License-Expression: MIT
6
+ Project-URL: Homepage, https://github.com/SharnavM/compatag
7
+ Project-URL: Repository, https://github.com/SharnavM/compatag
8
+ Project-URL: Issues, https://github.com/SharnavM/compatag/issues
9
+ Classifier: Intended Audience :: Developers
10
+ Classifier: Programming Language :: Python :: 3
11
+ Classifier: Programming Language :: Python :: 3 :: Only
12
+ Classifier: Programming Language :: Python :: 3.11
13
+ Classifier: Programming Language :: Python :: 3.12
14
+ Classifier: Programming Language :: Python :: 3.13
15
+ Classifier: Programming Language :: Python :: 3.14
16
+ Classifier: Topic :: Software Development :: Libraries :: Python Modules
17
+ Classifier: Topic :: Software Development :: Quality Assurance
18
+ Requires-Python: >=3.11
19
+ Description-Content-Type: text/markdown
20
+ License-File: LICENSE
21
+ Requires-Dist: httpx<1,>=0.28
22
+ Requires-Dist: mcp<3,>=2.2
23
+ Requires-Dist: packaging<27,>=26.3
24
+ Requires-Dist: pydantic<3,>=2.13
25
+ Provides-Extra: dev
26
+ Requires-Dist: build>=1.6; extra == "dev"
27
+ Requires-Dist: mypy>=2.3; extra == "dev"
28
+ Requires-Dist: pytest>=9.1; extra == "dev"
29
+ Requires-Dist: pytest-asyncio<2,>=1.4; extra == "dev"
30
+ Requires-Dist: pytest-cov>=7.1; extra == "dev"
31
+ Requires-Dist: ruff>=0.16.5; extra == "dev"
32
+ Requires-Dist: twine>=7.0; extra == "dev"
33
+ Dynamic: license-file
34
+
35
+ <h1 align="center">Compatag</h1>
36
+
37
+ <p align="center">
38
+ <a href="https://github.com/SharnavM/compatag/actions/workflows/test.yml"><img src="https://img.shields.io/github/actions/workflow/status/SharnavM/compatag/test.yml?label=CI" alt="CI status"></a> <a href="https://pypi.org/project/compatag/"><img src="https://img.shields.io/pypi/v/compatag" alt="PyPI version"></a> <a href="pyproject.toml"><img src="https://img.shields.io/badge/Python-%3E%3D3.11-blue" alt="Python >=3.11"></a> <a href="LICENSE"><img src="https://img.shields.io/badge/License-MIT-green" alt="MIT license"></a>
39
+ </p>
40
+
41
+ Compatag preflights Python package compatibility before deployment. It checks published PyPI package artifacts against explicit Python versions and platforms, identifying compatible wheels and cases that may require a source build.
42
+
43
+ Compatag is available through a command-line interface and a local MCP server. Its results describe published metadata and artifacts; they do not guarantee that an application will run successfully.
44
+
45
+ ## Contents
46
+
47
+ - [Demo](#demo)
48
+ - [Features](#features)
49
+ - [Installation](#installation)
50
+ - [How to Use](#how-to-use)
51
+ - [Current Scope and Limitations](#current-scope-and-limitations)
52
+ - [To-do](#to-do)
53
+ - [License](#license)
54
+
55
+ ## Demo
56
+
57
+ The video shows Compatag's MCP server in action with Codex. Playback is deliberately slowed during tool calls and while Codex presents conclusions based on the results, making these steps easier to follow.
58
+
59
+ https://github.com/user-attachments/assets/709741e3-4c93-4ec7-8706-19bcb4995c2e
60
+
61
+ ## Features
62
+
63
+ - **Package checks**: Checks a single Python requirement against an explicit CPython version and platform.
64
+ - **Dependency audits**: Audits direct dependencies in requirements-style files and PEP 621 `pyproject.toml` files, including selected optional dependency groups.
65
+ - **Wheel and source-build detection**: Detects compatible wheels and source-build requirements, taking `Requires-Python` and environment markers into account.
66
+ - **Target comparisons**: Compares two deployment targets, reporting compatibility, selected-version, artifact, and dependency-applicability changes.
67
+ - **CLI and MCP support**: Provides CLI commands with JSON output and three tools through a local MCP stdio server.
68
+ - **Concurrent analysis**: Analyzes PyPI packages concurrently, with configurable concurrency and resource limits.
69
+
70
+ ## Installation
71
+
72
+ Compatag requires Python 3.11 or newer. CI covers Python 3.11-3.14 on Windows and Ubuntu.
73
+
74
+ ### From PyPI
75
+
76
+ ```bash
77
+ pip install compatag
78
+ ```
79
+
80
+ ### From source
81
+
82
+ ```bash
83
+ git clone https://github.com/SharnavM/compatag.git
84
+ cd compatag
85
+ python -m pip install .
86
+ ```
87
+
88
+ For development, an editable installation includes the test and code-checking tools:
89
+
90
+ ```bash
91
+ python -m pip install -e ".[dev]"
92
+ ```
93
+
94
+ ## How to Use
95
+
96
+ ### CLI
97
+
98
+ Each command takes an explicit deployment target, independent of the machine running Compatag.
99
+
100
+ A single requirement check:
101
+
102
+ ```bash
103
+ compatag check "numpy>=2,<3" --python 3.11 --platform manylinux_2_17_aarch64
104
+ ```
105
+
106
+ A direct-dependency audit:
107
+
108
+ ```bash
109
+ compatag audit requirements.txt --python 3.11 --platform win_amd64
110
+ ```
111
+
112
+ For a project with a `dev` optional dependency group:
113
+
114
+ ```bash
115
+ compatag audit pyproject.toml --extra dev --python 3.11 --platform win_amd64
116
+ ```
117
+
118
+ A comparison between Windows x64 and ARM64 Linux:
119
+
120
+ ```bash
121
+ compatag compare requirements.txt --from-python 3.11 --from-platform win_amd64 --to-python 3.11 --to-platform manylinux_2_17_aarch64
122
+ ```
123
+
124
+ All three analysis commands support `--json` for structured output. The [CLI guide](docs/USAGE.md#cli) covers complete options, exit codes, and further examples.
125
+
126
+ ### MCP
127
+
128
+ Compatag exposes a local MCP stdio server through `compatag-mcp`. The MCP client launches the server and receives these tools:
129
+
130
+ | Tool | Purpose |
131
+ | ----------------- | --------------------------------------------------------- |
132
+ | `check_package` | Checks one requirement against a target. |
133
+ | `audit_manifest` | Audits a manifest's direct dependencies against a target. |
134
+ | `compare_targets` | Compares a manifest across two targets. |
135
+
136
+ The following registration examples assume that Compatag is installed and `compatag-mcp` is available on the client's `PATH`.
137
+
138
+ **[Codex CLI](https://developers.openai.com/codex/mcp):**
139
+
140
+ ```bash
141
+ codex mcp add compatag -- compatag-mcp
142
+ ```
143
+
144
+ **[Claude Code](https://code.claude.com/docs/en/mcp):**
145
+
146
+ ```bash
147
+ claude mcp add --transport stdio compatag -- compatag-mcp
148
+ ```
149
+
150
+ **Other clients (Cursor, Antigravity, and similar editors):**
151
+
152
+ Local stdio configuration uses `compatag-mcp` as the command, with no arguments. For clients that accept an `mcpServers` configuration, such as [Cursor](https://docs.cursor.com/context/model-context-protocol), a minimal entry is:
153
+
154
+ ```json
155
+ {
156
+ "mcpServers": {
157
+ "compatag": {
158
+ "command": "compatag-mcp",
159
+ "args": []
160
+ }
161
+ }
162
+ }
163
+ ```
164
+
165
+ The configuration location and format depend on the client. An absolute executable path can replace `compatag-mcp` when the installation is outside the client's `PATH`.
166
+
167
+ MCP manifest tools receive manifest contents, not arbitrary filesystem paths. The client reads the file and passes its text to Compatag. The [MCP guide](docs/USAGE.md#mcp) covers tool inputs, optional groups, and result handling.
168
+
169
+ ## Current Scope and Limitations
170
+
171
+ - Analysis covers direct dependencies. Transitive dependencies are not resolved.
172
+ - Interpreter support is currently limited to CPython.
173
+ - Results are based on published PyPI distribution metadata and artifacts. Compatag does not execute packages or guarantee application or runtime compatibility.
174
+ - A source distribution means a source build may be required. Compatag does not build it or prove that the build will succeed.
175
+ - Markers and Python constraints that cannot be resolved from the supplied target are reported as indeterminate.
176
+ - Direct URL requirements and local package paths are outside the current analysis scope. Pip directives such as `-r`, `-c`, `-e`, and `--index-url` produce manifest issues. Dynamically supplied project dependencies cannot be fully audited from static text.
177
+
178
+ The [manifest guide](docs/MANIFESTS.md) describes supported input syntax and limitations.
179
+
180
+ Further documentation covers [compatibility results](docs/COMPATIBILITY.md), [architecture](docs/ARCHITECTURE.md), [development](docs/DEVELOPMENT.md), and [releasing](docs/RELEASING.md).
181
+
182
+ ## To-do
183
+
184
+ - [ ] Transitive dependency resolution.
185
+ - [ ] Streamable HTTP MCP transport for remote deployment.
186
+
187
+ ## License
188
+
189
+ Compatag is released under the [MIT License](LICENSE).
@@ -0,0 +1,155 @@
1
+ <h1 align="center">Compatag</h1>
2
+
3
+ <p align="center">
4
+ <a href="https://github.com/SharnavM/compatag/actions/workflows/test.yml"><img src="https://img.shields.io/github/actions/workflow/status/SharnavM/compatag/test.yml?label=CI" alt="CI status"></a> <a href="https://pypi.org/project/compatag/"><img src="https://img.shields.io/pypi/v/compatag" alt="PyPI version"></a> <a href="pyproject.toml"><img src="https://img.shields.io/badge/Python-%3E%3D3.11-blue" alt="Python >=3.11"></a> <a href="LICENSE"><img src="https://img.shields.io/badge/License-MIT-green" alt="MIT license"></a>
5
+ </p>
6
+
7
+ Compatag preflights Python package compatibility before deployment. It checks published PyPI package artifacts against explicit Python versions and platforms, identifying compatible wheels and cases that may require a source build.
8
+
9
+ Compatag is available through a command-line interface and a local MCP server. Its results describe published metadata and artifacts; they do not guarantee that an application will run successfully.
10
+
11
+ ## Contents
12
+
13
+ - [Demo](#demo)
14
+ - [Features](#features)
15
+ - [Installation](#installation)
16
+ - [How to Use](#how-to-use)
17
+ - [Current Scope and Limitations](#current-scope-and-limitations)
18
+ - [To-do](#to-do)
19
+ - [License](#license)
20
+
21
+ ## Demo
22
+
23
+ The video shows Compatag's MCP server in action with Codex. Playback is deliberately slowed during tool calls and while Codex presents conclusions based on the results, making these steps easier to follow.
24
+
25
+ https://github.com/user-attachments/assets/709741e3-4c93-4ec7-8706-19bcb4995c2e
26
+
27
+ ## Features
28
+
29
+ - **Package checks**: Checks a single Python requirement against an explicit CPython version and platform.
30
+ - **Dependency audits**: Audits direct dependencies in requirements-style files and PEP 621 `pyproject.toml` files, including selected optional dependency groups.
31
+ - **Wheel and source-build detection**: Detects compatible wheels and source-build requirements, taking `Requires-Python` and environment markers into account.
32
+ - **Target comparisons**: Compares two deployment targets, reporting compatibility, selected-version, artifact, and dependency-applicability changes.
33
+ - **CLI and MCP support**: Provides CLI commands with JSON output and three tools through a local MCP stdio server.
34
+ - **Concurrent analysis**: Analyzes PyPI packages concurrently, with configurable concurrency and resource limits.
35
+
36
+ ## Installation
37
+
38
+ Compatag requires Python 3.11 or newer. CI covers Python 3.11-3.14 on Windows and Ubuntu.
39
+
40
+ ### From PyPI
41
+
42
+ ```bash
43
+ pip install compatag
44
+ ```
45
+
46
+ ### From source
47
+
48
+ ```bash
49
+ git clone https://github.com/SharnavM/compatag.git
50
+ cd compatag
51
+ python -m pip install .
52
+ ```
53
+
54
+ For development, an editable installation includes the test and code-checking tools:
55
+
56
+ ```bash
57
+ python -m pip install -e ".[dev]"
58
+ ```
59
+
60
+ ## How to Use
61
+
62
+ ### CLI
63
+
64
+ Each command takes an explicit deployment target, independent of the machine running Compatag.
65
+
66
+ A single requirement check:
67
+
68
+ ```bash
69
+ compatag check "numpy>=2,<3" --python 3.11 --platform manylinux_2_17_aarch64
70
+ ```
71
+
72
+ A direct-dependency audit:
73
+
74
+ ```bash
75
+ compatag audit requirements.txt --python 3.11 --platform win_amd64
76
+ ```
77
+
78
+ For a project with a `dev` optional dependency group:
79
+
80
+ ```bash
81
+ compatag audit pyproject.toml --extra dev --python 3.11 --platform win_amd64
82
+ ```
83
+
84
+ A comparison between Windows x64 and ARM64 Linux:
85
+
86
+ ```bash
87
+ compatag compare requirements.txt --from-python 3.11 --from-platform win_amd64 --to-python 3.11 --to-platform manylinux_2_17_aarch64
88
+ ```
89
+
90
+ All three analysis commands support `--json` for structured output. The [CLI guide](docs/USAGE.md#cli) covers complete options, exit codes, and further examples.
91
+
92
+ ### MCP
93
+
94
+ Compatag exposes a local MCP stdio server through `compatag-mcp`. The MCP client launches the server and receives these tools:
95
+
96
+ | Tool | Purpose |
97
+ | ----------------- | --------------------------------------------------------- |
98
+ | `check_package` | Checks one requirement against a target. |
99
+ | `audit_manifest` | Audits a manifest's direct dependencies against a target. |
100
+ | `compare_targets` | Compares a manifest across two targets. |
101
+
102
+ The following registration examples assume that Compatag is installed and `compatag-mcp` is available on the client's `PATH`.
103
+
104
+ **[Codex CLI](https://developers.openai.com/codex/mcp):**
105
+
106
+ ```bash
107
+ codex mcp add compatag -- compatag-mcp
108
+ ```
109
+
110
+ **[Claude Code](https://code.claude.com/docs/en/mcp):**
111
+
112
+ ```bash
113
+ claude mcp add --transport stdio compatag -- compatag-mcp
114
+ ```
115
+
116
+ **Other clients (Cursor, Antigravity, and similar editors):**
117
+
118
+ Local stdio configuration uses `compatag-mcp` as the command, with no arguments. For clients that accept an `mcpServers` configuration, such as [Cursor](https://docs.cursor.com/context/model-context-protocol), a minimal entry is:
119
+
120
+ ```json
121
+ {
122
+ "mcpServers": {
123
+ "compatag": {
124
+ "command": "compatag-mcp",
125
+ "args": []
126
+ }
127
+ }
128
+ }
129
+ ```
130
+
131
+ The configuration location and format depend on the client. An absolute executable path can replace `compatag-mcp` when the installation is outside the client's `PATH`.
132
+
133
+ MCP manifest tools receive manifest contents, not arbitrary filesystem paths. The client reads the file and passes its text to Compatag. The [MCP guide](docs/USAGE.md#mcp) covers tool inputs, optional groups, and result handling.
134
+
135
+ ## Current Scope and Limitations
136
+
137
+ - Analysis covers direct dependencies. Transitive dependencies are not resolved.
138
+ - Interpreter support is currently limited to CPython.
139
+ - Results are based on published PyPI distribution metadata and artifacts. Compatag does not execute packages or guarantee application or runtime compatibility.
140
+ - A source distribution means a source build may be required. Compatag does not build it or prove that the build will succeed.
141
+ - Markers and Python constraints that cannot be resolved from the supplied target are reported as indeterminate.
142
+ - Direct URL requirements and local package paths are outside the current analysis scope. Pip directives such as `-r`, `-c`, `-e`, and `--index-url` produce manifest issues. Dynamically supplied project dependencies cannot be fully audited from static text.
143
+
144
+ The [manifest guide](docs/MANIFESTS.md) describes supported input syntax and limitations.
145
+
146
+ Further documentation covers [compatibility results](docs/COMPATIBILITY.md), [architecture](docs/ARCHITECTURE.md), [development](docs/DEVELOPMENT.md), and [releasing](docs/RELEASING.md).
147
+
148
+ ## To-do
149
+
150
+ - [ ] Transitive dependency resolution.
151
+ - [ ] Streamable HTTP MCP transport for remote deployment.
152
+
153
+ ## License
154
+
155
+ Compatag is released under the [MIT License](LICENSE).
@@ -0,0 +1,100 @@
1
+ [build-system]
2
+ requires = ["setuptools>=80"]
3
+ build-backend = "setuptools.build_meta"
4
+
5
+
6
+ [project]
7
+ name = "compatag"
8
+ version = "0.1.0"
9
+ description = "Preflight Python package compatibility across Python versions and platforms."
10
+ readme = "README.md"
11
+ requires-python = ">=3.11"
12
+ license = "MIT"
13
+ license-files = ["LICENSE"]
14
+
15
+ classifiers = [
16
+ "Intended Audience :: Developers",
17
+ "Programming Language :: Python :: 3",
18
+ "Programming Language :: Python :: 3 :: Only",
19
+ "Programming Language :: Python :: 3.11",
20
+ "Programming Language :: Python :: 3.12",
21
+ "Programming Language :: Python :: 3.13",
22
+ "Programming Language :: Python :: 3.14",
23
+ "Topic :: Software Development :: Libraries :: Python Modules",
24
+ "Topic :: Software Development :: Quality Assurance",
25
+ ]
26
+
27
+ dependencies = [
28
+ "httpx>=0.28,<1",
29
+ "mcp>=2.2,<3",
30
+ "packaging>=26.3,<27",
31
+ "pydantic>=2.13,<3",
32
+ ]
33
+
34
+
35
+ [project.optional-dependencies]
36
+ dev = [
37
+ "build>=1.6",
38
+ "mypy>=2.3",
39
+ "pytest>=9.1",
40
+ "pytest-asyncio>=1.4,<2",
41
+ "pytest-cov>=7.1",
42
+ "ruff>=0.16.5",
43
+ "twine>=7.0",
44
+ ]
45
+
46
+
47
+ [project.scripts]
48
+ compatag = "compatag.cli:main"
49
+ compatag-mcp = "compatag.mcp_server:main"
50
+
51
+ [project.urls]
52
+ Homepage = "https://github.com/SharnavM/compatag"
53
+ Repository = "https://github.com/SharnavM/compatag"
54
+ Issues = "https://github.com/SharnavM/compatag/issues"
55
+
56
+
57
+ [tool.setuptools.packages.find]
58
+ where = ["src"]
59
+
60
+
61
+ [tool.pytest.ini_options]
62
+ testpaths = ["tests"]
63
+ addopts = [
64
+ "-ra",
65
+ "--strict-config",
66
+ "--strict-markers",
67
+ ]
68
+ asyncio_mode = "strict"
69
+
70
+
71
+ [tool.coverage.run]
72
+ branch = true
73
+ source = ["compatag"]
74
+
75
+
76
+ [tool.coverage.report]
77
+ show_missing = true
78
+ skip_covered = true
79
+
80
+
81
+ [tool.ruff]
82
+ target-version = "py311"
83
+ line-length = 100
84
+
85
+
86
+ [tool.ruff.lint]
87
+ select = [
88
+ "E",
89
+ "F",
90
+ "I",
91
+ "UP",
92
+ "B",
93
+ ]
94
+
95
+
96
+ [tool.mypy]
97
+ python_version = "3.11"
98
+ strict = true
99
+ pretty = true
100
+ show_error_codes = true
@@ -0,0 +1,4 @@
1
+ [egg_info]
2
+ tag_build =
3
+ tag_date = 0
4
+
@@ -0,0 +1 @@
1
+ """Python package compatibility analysis for deployment targets."""
@@ -0,0 +1,3 @@
1
+ from compatag.cli import main
2
+
3
+ raise SystemExit(main())