Skip to content

Commit be49d45

Browse files
committed
docs(pypi): align 1.3.5 changelog and package metadata
1 parent 0d88e4b commit be49d45

4 files changed

Lines changed: 148 additions & 2 deletions

File tree

.github/copilot-instructions.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -113,6 +113,14 @@ For hand-authored Markdown in this repository, treat baseline docs as a coherent
113113
- Prefer consistency across related docs: if `README.md`, architecture docs, and workflow docs describe the same flow, they should use compatible terminology and diagram style.
114114
- When modernizing older docs, convert diagrams selectively rather than mechanically. Preserve useful content first, then improve presentation.
115115

116+
## PyPI README Sync Rules
117+
118+
- `README.md` is the canonical full documentation for GitHub rendering.
119+
- `README-pypi.md` is the PyPI-compatible long description source referenced by `pyproject.toml`.
120+
- Whenever `README.md` changes in a way that affects installation, usage, positioning, links, or badges, update `README-pypi.md` in the same change.
121+
- Keep `README-pypi.md` minimal and PyPI-safe: no Mermaid blocks, no relative documentation links, and no `<picture>` markup.
122+
- Use absolute GitHub URLs in `README-pypi.md` for cross-document links and images.
123+
116124
## Python Docstring Style
117125

118126
For Python modules in this repository, treat code as the source of truth and keep docstrings aligned with shipped behavior.

CHANGELOG.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,18 @@
22

33
## 1.3.5 - 2026-04-22
44

5-
Changelog alignment update.
5+
Changelog and PyPI packaging metadata alignment update.
66

77
### Changed in 1.3.5
88

99
- Corrected changelog version history from 1.3.0 onward so entries align with actual created tags and release chronology.
10+
- Switched published long description source from `README.md` to `README-pypi.md` for PyPI-compatible rendering.
11+
- Added PyPI-focused project metadata in `pyproject.toml`: `keywords`, `classifiers`, and `project.urls`.
12+
- Added explicit repository guidance to keep `README-pypi.md` in sync with `README.md`.
13+
14+
### Added in 1.3.5
15+
16+
- Added a dedicated `README-pypi.md` with PyPI-safe links, badges, and a concise DX-first quickstart.
1017

1118
## 1.3.4 - 2026-04-22
1219

README-pypi.md

Lines changed: 96 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,96 @@
1+
# vstack
2+
3+
[![PyPI version](https://img.shields.io/pypi/v/vstack?color=0B8A6F)](https://pypi.org/project/vstack/)
4+
[![Python version](https://img.shields.io/badge/python-3.11--3.14-0B8A6F)](https://github.com/eschaar/vstack/blob/main/pyproject.toml)
5+
[![Verify status](https://img.shields.io/github/actions/workflow/status/eschaar/vstack/verify.yml?branch=main&label=verify&color=1D6FA5)](https://github.com/eschaar/vstack/actions/workflows/verify.yml)
6+
[![Security checks](https://img.shields.io/github/actions/workflow/status/eschaar/vstack/security.yml?branch=main&label=security&color=B15E00)](https://github.com/eschaar/vstack/actions/workflows/security.yml)
7+
[![Runtime: stdlib only](https://img.shields.io/badge/runtime-stdlib%20only-5B6C8F)](https://github.com/eschaar/vstack/blob/main/pyproject.toml)
8+
[![License: MIT](https://img.shields.io/github/license/eschaar/vstack?color=5F7A1F)](https://github.com/eschaar/vstack/blob/main/LICENSE)
9+
[![GitHub Discussions](https://img.shields.io/badge/discussions-ask%20%26%20share-blueviolet?logo=github)](https://github.com/eschaar/vstack/discussions)
10+
11+
![vstack logo](https://raw.githubusercontent.com/eschaar/vstack/main/assets/branding/vstack.png)
12+
13+
The VS Code-native AI workflow system for backend engineering.
14+
15+
vstack installs structured agents, skills, instructions, and prompts into `.github/` so GitHub Copilot Agent Mode can run repeatable backend workflows with clear role boundaries.
16+
17+
It provides a fixed role model for end-to-end software delivery: `product`, `architect`, `designer`, `engineer`, `tester`, and `release`.
18+
19+
## Best for
20+
21+
- Backend and API teams using GitHub Copilot Agent Mode in VS Code
22+
- Repositories that want consistent planning, implementation, verification, and release flow
23+
- Teams that want reusable AI workflows instead of one-off prompt crafting
24+
25+
## What you get
26+
27+
- Fixed role model: `product`, `architect`, `designer`, `engineer`, `tester`, `release`
28+
- Template-driven install model from `src/vstack/_templates/`
29+
- Backend-first verification, security, and release discipline
30+
- Standard-library-only runtime dependencies
31+
32+
## Quick start
33+
34+
Install with `pipx`, then install vstack artifacts into your repository:
35+
36+
```bash
37+
pipx install vstack
38+
vstack install --target /path/to/your/project
39+
vstack validate
40+
```
41+
42+
Run a first task in Copilot Agent Mode:
43+
44+
```text
45+
@tester /verify Check this repository and summarize findings
46+
```
47+
48+
Expected result:
49+
50+
- `vstack validate` reports no unresolved template tokens
51+
- Agent command returns a concrete verification summary for your repository
52+
53+
## Why this helps
54+
55+
- Consistent role boundaries for planning, implementation, validation, and release
56+
- Reusable skills and instructions instead of ad hoc prompts
57+
- Better release hygiene with documented workflows and CI alignment
58+
59+
## Core commands
60+
61+
```bash
62+
vstack --version
63+
vstack validate
64+
vstack install --target /path/to/your/project
65+
vstack verify --target /path/to/your/project
66+
```
67+
68+
## Common usage patterns
69+
70+
Repository-scoped install (recommended for teams):
71+
72+
```bash
73+
vstack install --target /path/to/your/project
74+
```
75+
76+
Profile-wide install (optional defaults for all projects):
77+
78+
```bash
79+
vstack install --global
80+
```
81+
82+
## Fast troubleshooting
83+
84+
- Command not found after install: ensure your `pipx` binary path is in `PATH`
85+
- Validation error: rerun `vstack install --target ...` and then `vstack validate`
86+
- Agent results look generic: explicitly invoke a role (for example `@tester`) before a skill
87+
88+
## Full documentation
89+
90+
For complete documentation (including architecture details, workflow diagrams, and contributor guides), use GitHub:
91+
92+
- [GitHub repository](https://github.com/eschaar/vstack)
93+
- [Full README](https://github.com/eschaar/vstack/blob/main/README.md)
94+
- [Documentation](https://github.com/eschaar/vstack/tree/main/docs)
95+
- [Contributing guide](https://github.com/eschaar/vstack/blob/main/CONTRIBUTING.md)
96+
- [Security policy](https://github.com/eschaar/vstack/blob/main/SECURITY.md)

pyproject.toml

Lines changed: 36 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,44 @@ name = "vstack"
33
dynamic = ["version"]
44
description = "VS Code-native AI engineering workflow system for microservices, libraries, and backend systems."
55
license = "MIT"
6-
readme = "README.md"
6+
readme = "README-pypi.md"
77
requires-python = ">=3.11,<3.15"
88
dependencies = []
9+
keywords = [
10+
"github-copilot",
11+
"vscode",
12+
"ai-workflows",
13+
"developer-tools",
14+
"devx",
15+
"engineering-workflow",
16+
"copilot-agent-mode",
17+
"backend",
18+
"microservices",
19+
"api",
20+
"workflow-automation",
21+
"release-engineering",
22+
]
23+
classifiers = [
24+
"License :: OSI Approved :: MIT License",
25+
"Programming Language :: Python :: 3",
26+
"Programming Language :: Python :: 3.11",
27+
"Programming Language :: Python :: 3.12",
28+
"Programming Language :: Python :: 3.13",
29+
"Programming Language :: Python :: 3.14",
30+
"Environment :: Console",
31+
"Intended Audience :: Developers",
32+
"Topic :: Software Development :: Build Tools",
33+
"Topic :: Software Development :: Libraries :: Python Modules",
34+
]
35+
36+
[project.urls]
37+
Homepage = "https://github.com/eschaar/vstack"
38+
Documentation = "https://github.com/eschaar/vstack/blob/main/README.md"
39+
Repository = "https://github.com/eschaar/vstack"
40+
Issues = "https://github.com/eschaar/vstack/issues"
41+
Changelog = "https://github.com/eschaar/vstack/blob/main/CHANGELOG.md"
42+
Discussions = "https://github.com/eschaar/vstack/discussions"
43+
Security = "https://github.com/eschaar/vstack/blob/main/SECURITY.md"
944

1045
[project.scripts]
1146
vstack = "vstack:main"

0 commit comments

Comments
 (0)