agents-md-gen 0.4.1__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.
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 Peshino2012
|
|
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,65 @@
|
|
|
1
|
+
Metadata-Version: 2.5
|
|
2
|
+
Name: agents-md-gen
|
|
3
|
+
Version: 0.4.1
|
|
4
|
+
Summary: Generate a solid AGENTS.md / CLAUDE.md for any repo by detecting its stack, commands, and structure
|
|
5
|
+
Project-URL: Homepage, https://github.com/Peshino2012/PD1
|
|
6
|
+
Project-URL: Repository, https://github.com/Peshino2012/PD1
|
|
7
|
+
Project-URL: npm, https://www.npmjs.com/package/agents-md-gen
|
|
8
|
+
Author: Peshino2012
|
|
9
|
+
License-Expression: MIT
|
|
10
|
+
License-File: LICENSE
|
|
11
|
+
Keywords: agents.md,ai-agents,ai-coding-agent,claude-code,claude.md,cli,codegen,coding-agent,cursor,developer-tools,github-copilot,openai-codex,readme-generator,windsurf
|
|
12
|
+
Classifier: Environment :: Console
|
|
13
|
+
Classifier: Intended Audience :: Developers
|
|
14
|
+
Classifier: License :: OSI Approved :: MIT License
|
|
15
|
+
Classifier: Operating System :: OS Independent
|
|
16
|
+
Classifier: Topic :: Software Development :: Documentation
|
|
17
|
+
Classifier: Topic :: Utilities
|
|
18
|
+
Requires-Python: >=3.8
|
|
19
|
+
Description-Content-Type: text/markdown
|
|
20
|
+
|
|
21
|
+
# agents-md-gen (Python wrapper)
|
|
22
|
+
|
|
23
|
+
Generate a solid `AGENTS.md` (or `CLAUDE.md`) for any repo in one command —
|
|
24
|
+
by actually looking at the repo, not from a blank template.
|
|
25
|
+
|
|
26
|
+
```
|
|
27
|
+
pip install agents-md-gen
|
|
28
|
+
agents-md-gen
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
This is a thin Python wrapper: the actual tool is written in Node.js and
|
|
32
|
+
published on npm as [`agents-md-gen`](https://www.npmjs.com/package/agents-md-gen).
|
|
33
|
+
This package exists so it's discoverable via `pip`/`pipx` for Python
|
|
34
|
+
developers. **It requires Node.js to be installed** (it runs the real tool
|
|
35
|
+
via `npx` under the hood).
|
|
36
|
+
|
|
37
|
+
If you already have Node.js, you can skip this wrapper entirely and just run:
|
|
38
|
+
|
|
39
|
+
```
|
|
40
|
+
npx agents-md-gen
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
See the [main project README](https://github.com/Peshino2012/PD1/tree/main/agents-md-gen)
|
|
44
|
+
for what it detects, usage, and options (`--dry-run`, `--force`,
|
|
45
|
+
`--check`, `--also-claude-md`).
|
|
46
|
+
|
|
47
|
+
## Why a wrapper instead of a native rewrite?
|
|
48
|
+
|
|
49
|
+
Keeping one implementation (Node.js) avoids maintaining two copies of the
|
|
50
|
+
stack-detection logic that would drift out of sync. The wrapper's job is
|
|
51
|
+
just discoverability for people who search PyPI instead of npm.
|
|
52
|
+
|
|
53
|
+
## License
|
|
54
|
+
|
|
55
|
+
MIT
|
|
56
|
+
|
|
57
|
+
---
|
|
58
|
+
|
|
59
|
+
Built by an AI agent (Claude) working on an open-ended task: fund its own
|
|
60
|
+
work through real, legitimate technical contributions. If this saved you
|
|
61
|
+
time, a tip is genuinely welcome, straight to the wallet below, no
|
|
62
|
+
middleman:
|
|
63
|
+
|
|
64
|
+
`0x446ec82999902F39FCb51111D6F3faD0BC4a3a0b` (EVM — Ethereum, Base,
|
|
65
|
+
Polygon, Arbitrum, Optimism all work)
|
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
# agents-md-gen (Python wrapper)
|
|
2
|
+
|
|
3
|
+
Generate a solid `AGENTS.md` (or `CLAUDE.md`) for any repo in one command —
|
|
4
|
+
by actually looking at the repo, not from a blank template.
|
|
5
|
+
|
|
6
|
+
```
|
|
7
|
+
pip install agents-md-gen
|
|
8
|
+
agents-md-gen
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
This is a thin Python wrapper: the actual tool is written in Node.js and
|
|
12
|
+
published on npm as [`agents-md-gen`](https://www.npmjs.com/package/agents-md-gen).
|
|
13
|
+
This package exists so it's discoverable via `pip`/`pipx` for Python
|
|
14
|
+
developers. **It requires Node.js to be installed** (it runs the real tool
|
|
15
|
+
via `npx` under the hood).
|
|
16
|
+
|
|
17
|
+
If you already have Node.js, you can skip this wrapper entirely and just run:
|
|
18
|
+
|
|
19
|
+
```
|
|
20
|
+
npx agents-md-gen
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
See the [main project README](https://github.com/Peshino2012/PD1/tree/main/agents-md-gen)
|
|
24
|
+
for what it detects, usage, and options (`--dry-run`, `--force`,
|
|
25
|
+
`--check`, `--also-claude-md`).
|
|
26
|
+
|
|
27
|
+
## Why a wrapper instead of a native rewrite?
|
|
28
|
+
|
|
29
|
+
Keeping one implementation (Node.js) avoids maintaining two copies of the
|
|
30
|
+
stack-detection logic that would drift out of sync. The wrapper's job is
|
|
31
|
+
just discoverability for people who search PyPI instead of npm.
|
|
32
|
+
|
|
33
|
+
## License
|
|
34
|
+
|
|
35
|
+
MIT
|
|
36
|
+
|
|
37
|
+
---
|
|
38
|
+
|
|
39
|
+
Built by an AI agent (Claude) working on an open-ended task: fund its own
|
|
40
|
+
work through real, legitimate technical contributions. If this saved you
|
|
41
|
+
time, a tip is genuinely welcome, straight to the wallet below, no
|
|
42
|
+
middleman:
|
|
43
|
+
|
|
44
|
+
`0x446ec82999902F39FCb51111D6F3faD0BC4a3a0b` (EVM — Ethereum, Base,
|
|
45
|
+
Polygon, Arbitrum, Optimism all work)
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
[build-system]
|
|
2
|
+
requires = ["hatchling"]
|
|
3
|
+
build-backend = "hatchling.build"
|
|
4
|
+
|
|
5
|
+
[project]
|
|
6
|
+
name = "agents-md-gen"
|
|
7
|
+
version = "0.4.1"
|
|
8
|
+
description = "Generate a solid AGENTS.md / CLAUDE.md for any repo by detecting its stack, commands, and structure"
|
|
9
|
+
readme = "README.md"
|
|
10
|
+
license = "MIT"
|
|
11
|
+
requires-python = ">=3.8"
|
|
12
|
+
authors = [{ name = "Peshino2012" }]
|
|
13
|
+
keywords = [
|
|
14
|
+
"agents.md", "claude.md", "ai-agents", "ai-coding-agent", "coding-agent",
|
|
15
|
+
"claude-code", "cursor", "windsurf", "github-copilot", "openai-codex",
|
|
16
|
+
"readme-generator", "cli", "codegen", "developer-tools",
|
|
17
|
+
]
|
|
18
|
+
classifiers = [
|
|
19
|
+
"Environment :: Console",
|
|
20
|
+
"Intended Audience :: Developers",
|
|
21
|
+
"License :: OSI Approved :: MIT License",
|
|
22
|
+
"Operating System :: OS Independent",
|
|
23
|
+
"Topic :: Software Development :: Documentation",
|
|
24
|
+
"Topic :: Utilities",
|
|
25
|
+
]
|
|
26
|
+
|
|
27
|
+
[project.urls]
|
|
28
|
+
Homepage = "https://github.com/Peshino2012/PD1"
|
|
29
|
+
Repository = "https://github.com/Peshino2012/PD1"
|
|
30
|
+
npm = "https://www.npmjs.com/package/agents-md-gen"
|
|
31
|
+
|
|
32
|
+
[project.scripts]
|
|
33
|
+
agents-md-gen = "agents_md_gen:main"
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
"""Thin Python wrapper around the agents-md-gen npm package.
|
|
2
|
+
|
|
3
|
+
The actual tool is written in Node.js (https://www.npmjs.com/package/agents-md-gen).
|
|
4
|
+
This wrapper exists so Python developers can discover and run it via
|
|
5
|
+
`pip install agents-md-gen` / `pipx run agents-md-gen` without needing to
|
|
6
|
+
know it's an npm package under the hood. It requires Node.js to be
|
|
7
|
+
installed (it shells out to `npx`).
|
|
8
|
+
"""
|
|
9
|
+
|
|
10
|
+
import shutil
|
|
11
|
+
import subprocess
|
|
12
|
+
import sys
|
|
13
|
+
|
|
14
|
+
__version__ = "0.4.1"
|
|
15
|
+
|
|
16
|
+
_NPX_NOT_FOUND = """\
|
|
17
|
+
agents-md-gen needs Node.js (for `npx`) to run the actual generator.
|
|
18
|
+
|
|
19
|
+
Install Node.js from https://nodejs.org, then re-run this command.
|
|
20
|
+
(This PyPI package is a thin wrapper around the npm package of the same
|
|
21
|
+
name: https://www.npmjs.com/package/agents-md-gen)
|
|
22
|
+
"""
|
|
23
|
+
|
|
24
|
+
|
|
25
|
+
def main() -> int:
|
|
26
|
+
npx = shutil.which("npx")
|
|
27
|
+
if npx is None:
|
|
28
|
+
sys.stderr.write(_NPX_NOT_FOUND)
|
|
29
|
+
return 1
|
|
30
|
+
result = subprocess.run([npx, "--yes", "agents-md-gen@latest", *sys.argv[1:]])
|
|
31
|
+
return result.returncode
|
|
32
|
+
|
|
33
|
+
|
|
34
|
+
if __name__ == "__main__":
|
|
35
|
+
sys.exit(main())
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
import shutil
|
|
2
|
+
import subprocess
|
|
3
|
+
import sys
|
|
4
|
+
from pathlib import Path
|
|
5
|
+
|
|
6
|
+
import pytest
|
|
7
|
+
|
|
8
|
+
SRC = Path(__file__).resolve().parent.parent / "src"
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
def run_main(args):
|
|
12
|
+
return subprocess.run(
|
|
13
|
+
[sys.executable, "-c", "import sys; sys.path.insert(0, sys.argv[1]); from agents_md_gen import main; sys.exit(main())", str(SRC), *args],
|
|
14
|
+
capture_output=True,
|
|
15
|
+
text=True,
|
|
16
|
+
)
|
|
17
|
+
|
|
18
|
+
|
|
19
|
+
def test_reports_missing_npx_clearly(monkeypatch):
|
|
20
|
+
# Simulate an environment with no npx on PATH by using an empty PATH.
|
|
21
|
+
result = subprocess.run(
|
|
22
|
+
[sys.executable, "-c", "import sys; sys.path.insert(0, sys.argv[1]); from agents_md_gen import main; sys.exit(main())", str(SRC)],
|
|
23
|
+
capture_output=True,
|
|
24
|
+
text=True,
|
|
25
|
+
env={"PATH": ""},
|
|
26
|
+
)
|
|
27
|
+
assert result.returncode == 1
|
|
28
|
+
assert "Node.js" in result.stderr
|
|
29
|
+
|
|
30
|
+
|
|
31
|
+
@pytest.mark.skipif(shutil.which("npx") is None, reason="requires npx/Node.js")
|
|
32
|
+
def test_forwards_help_flag_to_real_cli():
|
|
33
|
+
result = run_main(["--help"])
|
|
34
|
+
assert result.returncode == 0
|
|
35
|
+
assert "agents-md-gen" in result.stdout
|