dev-charter 0.0.1__py3-none-any.whl

dev_charter/__init__.py

@@ -0,0 +1,3 @@
+# Copyright 2026 Joji John
+# SPDX-License-Identifier: Apache-2.0
+"""Dev Charter: features in plain English, traced to the code that builds them and the tests that prove them."""

dev_charter/cli.py

@@ -0,0 +1,17 @@
+# Copyright 2026 Joji John
+# SPDX-License-Identifier: Apache-2.0
+"""The `dev-charter` command."""
+
+import click
+
+REPOSITORY = "https://github.com/joji-opensource/charter"
+
+
+@click.group(invoke_without_command=True)
+@click.version_option(package_name="dev-charter", prog_name="Dev Charter")
+@click.pass_context
+def main(ctx: click.Context) -> None:
+    """Dev Charter: know what your product does, which code delivers it, and what is proven."""
+    if ctx.invoked_subcommand is None:
+        click.echo("Dev Charter is in early development and has no commands yet.")
+        click.echo(f"Follow {REPOSITORY} to hear when the first release ships.")

dev_charter-0.0.1.dist-info/METADATA

@@ -0,0 +1,227 @@
+Metadata-Version: 2.5
+Name: dev-charter
+Version: 0.0.1
+Summary: Know what your product does, which code delivers it, and what is proven, in one spreadsheet.
+Project-URL: Homepage, https://github.com/joji-opensource/charter
+Project-URL: Issues, https://github.com/joji-opensource/charter/issues
+Author: Joji John
+License-Expression: Apache-2.0
+License-File: LICENSE
+License-File: NOTICE
+Classifier: Development Status :: 1 - Planning
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Topic :: Software Development :: Quality Assurance
+Requires-Python: >=3.11
+Requires-Dist: click<9,>=8.1
+Description-Content-Type: text/markdown
+
+# Dev Charter
+
+**Know what your product does, which code delivers it, and what is proven — in one spreadsheet.**
+
+Dev Charter keeps a plain-English record of every feature your product promises, links each one to the code that
+builds it and the tests that prove it, and turns that into a spreadsheet a founder, product manager or executive
+can read in five minutes. It is built for teams who write software with Claude Code, where code now arrives faster
+than anyone can read it.
+
+> **Status: early development.** The first working release is being built. Version 0.0.1 on PyPI only holds the
+> name and does nothing yet; the commands below describe the first working release. Follow the repository to hear
+> when it ships.
+
+---
+
+## The problem
+
+AI coding agents let a small team build a large product quickly. The cost shows up later:
+
+- **Nobody can say what the product actually does today.** The code is there, but the answer to "can a customer
+  do X yet, and how do we know?" takes a day of reading or an engineer's opinion.
+- **Code grows that no one can explain.** Tens of thousands of lines appear, and no one can point to which
+  customer need each part serves, or whether any of it is still needed.
+- **Plans pile up as documents.** Designs, reviews and decision notes multiply until they are longer than the code
+  and too long to read.
+- **"Done" means "the agent said so."** Status is claimed, not proven, and it goes stale the moment the next
+  change lands.
+- **Scope drifts quietly.** Each "while I'm here" improvement looks reasonable on its own; together they build a
+  different product than the one you planned.
+
+## What you get
+
+### For founders and product owners
+
+- **One page that answers "where are we?"** Every feature, in plain English, with its status, in a spreadsheet at
+  the root of your project. No technical knowledge needed to read it.
+- **Features written the way customers think.** Each one reads *"As a customer, I want to … with … so that …"*,
+  followed by what "done" means in plain words. You review the product, not the code.
+- **Status you can trust.** A feature only moves to *Built* when its checks pass, and only to *Proven* when a named
+  person has seen it work on real data and signed it off. Status is never typed in: it is worked out from the
+  checks and the sign-offs, and every sign-off records who and when.
+- **Early warning.** A feature that used to work and now fails is flagged *At risk* the next time the
+  spreadsheet is generated, before a customer finds it.
+- **Control over what gets built.** Every piece of work names the feature it serves. Ideas that don't serve an
+  agreed feature are captured in one list for you to decide on later, instead of quietly becoming code.
+
+### For executives, investors and customers
+
+- **A summary you can share.** Features by area and status, the share that is proven, and what changed this week.
+- **Claims backed by evidence.** Every "this works" points to the checks behind it and the date it was last
+  proven.
+- **Release readiness at a glance.** See which features in a release are proven, which are built but unproven, and
+  which haven't started.
+
+### For engineers and AI coding agents
+
+- **Every task is tied to a customer need.** The agent knows which feature and which checks its work serves, and
+  what is out of bounds.
+- **Code that explains itself.** Each module carries a short tag naming the feature it serves. The *Code map* shows
+  every module, the features behind it, and the code that serves nothing: candidates to justify or remove.
+- **Decisions made once.** One decisions log, plain-English summary first, so settled questions are not reopened
+  in every session.
+- **Clean handoffs.** Each session ends with where it stopped and the exact next step, so the next session, or the
+  next person, starts without guessing.
+
+### Before and after
+
+| Question | Without Dev Charter | With Dev Charter |
+|---|---|---|
+| Is this feature done? | Ask someone, get an opinion | Open the spreadsheet: calculated status and last proven date |
+| Why does this code exist? | Read it, or guess | The *Code map* names the feature it serves |
+| What code serves nothing? | Nobody knows | Listed as *Unexplained code* |
+| What did we decide, and why? | Spread across chats and documents | One decisions log |
+| What changed this week? | A status report someone writes by hand | Generated after every commit |
+| Did the agent stay on task? | Find out in code review | Work that serves no feature is flagged before you commit |
+
+## What a feature looks like
+
+```
+F-014  ·  Area: Orders and delivery  ·  Priority: Must  ·  Release: Spring launch
+
+As a        customer of an online store
+I want to   see where my order is and when it will arrive
+With        the current step (packed, shipped, out for delivery), the expected delivery date,
+            and a text message when it is out for delivery
+Must also   load in under 2 seconds on a phone · show me only my own orders
+So that     I don't have to contact support to ask where my package is
+
+Done means
+  a. Every order shows its current step and expected delivery date
+  b. A text message is sent when the order goes out for delivery
+  c. Opening someone else's order shows a sign-in page, never their order
+
+Status      Built: 2 of 3 checks passing           (calculated)
+Built in    Orders service · Notifications         (found in the code)
+Proven by   7 automated checks · last real run 24 Oct
+Decisions   DEC-031 (delivery dates come from the carrier, never guessed)
+```
+
+You write the top half, or ask your agent to. Dev Charter fills in the bottom half from the code and the test results.
+
+**Statuses:** Idea → Agreed → Being built → Built → Proven → Live, plus *At risk*, *Parked* and *Retired*.
+
+**Promises** are product-wide rules that apply to many features, such as *"customers only ever see their own
+orders and details"* or *"the price shown is always the price charged"*. They get their own rows and their own
+checks.
+
+## How it works
+
+Dev Charter has three layers. You can use the first two on their own.
+
+1. **The Ledger: what and why.** One short text file per feature, promise and decision, kept in your repository.
+   People and agents write these.
+2. **The Trace: where and how do we know.** A one-line tag in each module (`serves: F-014`) and the feature's ID in
+   each test's name (`test_F014_b_text_sent`) link code and tests back to features. Dev Charter scans your
+   repositories, in any language, and reads test results in JUnit XML, which pytest and most test runners write
+   (Jest and Go through a small add-on).
+3. **The Workflow: how the agent works.** Task cards that name the feature they serve, a plan → review → prove →
+   build → ship loop, one list for parked ideas, and a handoff at the end of each session.
+
+`dev-charter report` combines all three into `LEDGER.xlsx` and a one-page `status.html`. They are rebuilt after every
+commit, on demand, and in CI, and never edited by hand, so they cannot drift from the truth.
+
+### Built for Claude Code
+
+Dev Charter's rules live in your repository, in `AGENTS.md`, which Claude Code reads every time it opens the project,
+so every teammate's sessions follow them. The full guide for each stage comes from the installed Dev Charter
+(`dev-charter guide plan`), so every project gets the same guides and upgrading Dev Charter upgrades them everywhere. The
+Dev Charter plugin adds commands such as `/dev-charter:feature` and `/dev-charter:plan`, and Strict mode.
+
+Other AI coding tools that read `AGENTS.md` are planned for a later release; this release is tested with Claude
+Code only.
+
+### The spreadsheet
+
+| Tab | What it shows |
+|---|---|
+| Summary | Features by area and status, share proven, what changed this week |
+| Features | One row per feature, the main view |
+| Promises | Product-wide rules and their status |
+| Code map | Each module and the features it serves; unexplained code flagged |
+| Decisions | Every decision, plain English first |
+| Ideas | Everything parked for later |
+
+## Choose how strict to be
+
+| Mode | When Dev Charter checks | Best for |
+|---|---|---|
+| **Light** | In CI, after work is merged | Prototypes, adding Dev Charter to an existing project gradually, teams without AI agents |
+| **Standard** | Before each commit | Everyday work where a person reviews and commits |
+| **Strict** | At every file change: Claude Code is blocked from writing outside its task | Long unattended agent runs, several agents at once, shared core code |
+
+Switch modes with one line in `charter.toml`, or turn on Strict for a single session.
+
+## Getting started
+
+**1. Install Dev Charter** (once per machine, in a terminal):
+
+```bash
+uv tool install dev-charter
+```
+
+**2. Add the Dev Charter plugin** (once per machine, inside Claude Code):
+
+```
+/plugin marketplace add joji-opensource/charter
+/plugin install dev-charter@dev-charter
+```
+
+**3. Set up your project** (open Claude Code in your project folder):
+
+```
+/dev-charter:init
+```
+
+Claude asks five questions (product name, repositories, product areas, user roles, how strict to be) and sets
+everything up. Prefer the terminal? `dev-charter init` asks the same questions.
+
+**4. Work**
+
+```
+/dev-charter:feature  As a customer I want to save products for later …
+/dev-charter:status   where are we?
+```
+
+`LEDGER.xlsx` and `status.html` are rebuilt after every commit; `dev-charter report` rebuilds them any time.
+
+`/dev-charter:init` adds only your product's own content to your project: a `charter.toml` settings file, a `charter/`
+folder with your features, promises, decisions, ideas, task cards and handoff, a short marked section in
+`AGENTS.md`, and git hooks that check each commit and refresh the spreadsheet. It never overwrites a hook you
+already have. Framework code never lives in your repository; upgrading Dev Charter upgrades every project that uses
+it.
+
+## What Dev Charter is not
+
+- **Not a task tracker.** It does not replace Jira, Linear or ClickUp for scheduling work. It records what the
+  product promises and whether each promise is kept.
+- **Not a test framework.** It reads the results of the tests you already run.
+- **Not tied to a language, stack or cloud.** Anything that can carry a comment and produce JUnit XML works.
+
+## License
+
+Apache License 2.0. See [LICENSE](https://github.com/joji-opensource/charter/blob/main/LICENSE) and
+[NOTICE](https://github.com/joji-opensource/charter/blob/main/NOTICE).
+
+If you redistribute Dev Charter or a modified version, keep the LICENSE file, the copyright notices and the NOTICE
+file, as the License requires.

dev_charter-0.0.1.dist-info/RECORD

@@ -0,0 +1,8 @@
+dev_charter/__init__.py,sha256=x65QNmIvLEzoJfMC5FsWvt2fpTPv4WeweujUml0Xcjo,178
+dev_charter/cli.py,sha256=PMaN3LIn78TAFP1Yw6tpMOFrFk2-w06mrqMxahsb628,647
+dev_charter-0.0.1.dist-info/METADATA,sha256=F0ThK_xa7XpB_V6JDyPpUDu2y1xR8sb4anC9yRAANXI,11398
+dev_charter-0.0.1.dist-info/WHEEL,sha256=W3fkpkm7-wf9vBI5Z-7s0eWkeM-spu78I8Neb98DeEg,87
+dev_charter-0.0.1.dist-info/entry_points.txt,sha256=l5SyAmfnMOCemSh4Ulwq6f-L4V7j15alziDk8ooryCE,53
+dev_charter-0.0.1.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+dev_charter-0.0.1.dist-info/licenses/NOTICE,sha256=yYIbJEVW0YaBqfbp3obxTiuyVosN2jePJ4FVZX_trOA,327
+dev_charter-0.0.1.dist-info/RECORD,,

dev_charter-0.0.1.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.32.4
+Root-Is-Purelib: true
+Tag: py3-none-any

dev_charter-0.0.1.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+dev-charter = dev_charter.cli:main

dev_charter-0.0.1.dist-info/licenses/LICENSE

@@ -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.

dev_charter-0.0.1.dist-info/licenses/NOTICE

@@ -0,0 +1,9 @@
+Dev Charter
+Copyright 2026 Joji John
+
+This product includes software developed by Joji John
+(https://github.com/joji-opensource/charter).
+
+Licensed under the Apache License, Version 2.0. See the LICENSE file for the
+full terms. This NOTICE file provides attribution only; it does not modify or
+add to the terms of the License.