From 349049517f57bb0fa7e0f2d743bd9a5d3aa6675d Mon Sep 17 00:00:00 2001 From: "kapil.madan" <3740365+kmadan@users.noreply.github.com> Date: Thu, 14 May 2026 13:54:11 +0530 Subject: [PATCH] docs(readme): switch Quick Start to 'pip install aicertify' + add PyPI badges MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit v0.7.0 is now live on PyPI (https://pypi.org/project/aicertify/0.7.0/), so the README's first instruction can be the single line everyone expects. ## Changes (applied to all 5 READMEs — English + zh-CN + ja-JP + ko-KR + hi-IN) ### Badges Added two new badges at the start of the badge row: - PyPI version (shields.io/pypi/v) - Total downloads (pepy.tech) Dropped the now-redundant hard-coded version-0.7.0 badge — the PyPI badge auto-updates on every release, which is what we want long-term. ### Quick Start Promoted pip install aicertify to the headline install instruction. Demoted the git-clone path to a follow-up step for running the bundled demo (which still needs the repo checked out for examples/quickstart.py), and added a separate "For development" / "開発用のセットアップ" / "개발용 설치" / "डेवलपमेंट के लिए" / "用于开发" section that keeps the `pip install -e .` editable-install path documented for contributors. All language switcher links + remaining badges + diagrams + every other README section is untouched. ## Verified - PyPI listing live: https://pypi.org/project/aicertify/0.7.0/ - Metadata complete on the live page: 16 keywords, 13+ classifiers, 6 project URLs (Homepage, Repository, Documentation, Issues, Changelog, Policy Library (gopal)), license Apache-2.0 - Both wheel + sdist uploaded and downloadable --- README.hi-IN.md | 18 ++++++++++++++++-- README.ja-JP.md | 18 ++++++++++++++++-- README.ko-KR.md | 18 ++++++++++++++++-- README.md | 18 ++++++++++++++++-- README.zh-CN.md | 18 ++++++++++++++++-- 5 files changed, 80 insertions(+), 10 deletions(-) diff --git a/README.hi-IN.md b/README.hi-IN.md index 8509214..d196878 100644 --- a/README.hi-IN.md +++ b/README.hi-IN.md @@ -21,9 +21,10 @@

+ PyPI + Downloads CI Stars - Version 0.7.0 Python 3.12+ Apache 2.0 Built on OPA @@ -46,15 +47,28 @@ ## Quick Start +```bash +pip install aicertify +``` + +बंडल्ड डेमो चलाने के लिए (सैंपल कॉन्ट्रैक्ट + examples के लिए रिपॉज़िटरी क्लोन करें): + ```bash git clone https://github.com/Principled-Evolution/aicertify.git cd aicertify -pip install -e . python examples/quickstart.py ``` यह क्विकस्टार्ट एक सैंपल AI एप्लिकेशन को EU AI Act पॉलिसी सेट के माध्यम से जोड़ता है और `reports/` में एक कंप्लायंस रिपोर्ट लिखता है। उसे खोलिए। यही आपके ऑडिट डिलिवरेबल का स्वरूप है — हाथ से नहीं, जनरेट होकर। +### डेवलपमेंट के लिए + +```bash +git clone https://github.com/Principled-Evolution/aicertify.git +cd aicertify +pip install -e . +``` + ### न्यूनतम Python उपयोग ```python diff --git a/README.ja-JP.md b/README.ja-JP.md index e273aea..e61ea14 100644 --- a/README.ja-JP.md +++ b/README.ja-JP.md @@ -21,9 +21,10 @@

+ PyPI + ダウンロード CI Stars - Version 0.7.0 Python 3.12+ Apache 2.0 Built on OPA @@ -46,15 +47,28 @@ ## クイックスタート +```bash +pip install aicertify +``` + +同梱のデモを実行するには(サンプル契約と examples 一式を取得するためにリポジトリをクローンします): + ```bash git clone https://github.com/Principled-Evolution/aicertify.git cd aicertify -pip install -e . python examples/quickstart.py ``` クイックスタートでは、サンプル AI アプリケーションを EU AI Act のポリシーセットに通し、コンプライアンスレポートを `reports/` に出力します。それを開いてみてください。手書きではなく、生成された監査成果物の実例です。 +### 開発用のセットアップ + +```bash +git clone https://github.com/Principled-Evolution/aicertify.git +cd aicertify +pip install -e . +``` + ### 最小限の Python での使い方 ```python diff --git a/README.ko-KR.md b/README.ko-KR.md index 58925e5..fbcc4ac 100644 --- a/README.ko-KR.md +++ b/README.ko-KR.md @@ -21,9 +21,10 @@

+ PyPI + 다운로드 CI Stars - Version 0.7.0 Python 3.12+ Apache 2.0 Built on OPA @@ -46,15 +47,28 @@ ## 빠른 시작 +```bash +pip install aicertify +``` + +샘플 계약과 예시를 함께 실행하려면 저장소를 클론하세요: + ```bash git clone https://github.com/Principled-Evolution/aicertify.git cd aicertify -pip install -e . python examples/quickstart.py ``` 빠른 시작 스크립트는 샘플 AI 애플리케이션을 EU AI Act 정책 세트에 통과시키고 컴플라이언스 리포트를 `reports/`에 작성합니다. 파일을 열어 보세요. 이것이 바로 여러분의 감사 산출물의 모습입니다 — 손으로 작성하지 않고 생성된 리포트입니다. +### 개발용 설치 + +```bash +git clone https://github.com/Principled-Evolution/aicertify.git +cd aicertify +pip install -e . +``` + ### 최소 Python 사용 예시 ```python diff --git a/README.md b/README.md index a13842f..b60143f 100644 --- a/README.md +++ b/README.md @@ -21,9 +21,10 @@

+ PyPI + Downloads CI Stars - Version 0.7.0 Python 3.12+ Apache 2.0 Built on OPA @@ -58,15 +59,28 @@ AICertify is part of the [Open Policy Agent ecosystem](https://www.openpolicyage ## Quick Start +```bash +pip install aicertify +``` + +To run the canonical demo (clone the repo for the sample contract + examples): + ```bash git clone https://github.com/Principled-Evolution/aicertify.git cd aicertify -pip install -e . python examples/quickstart.py ``` The quickstart wires a sample AI application through the EU AI Act policy set and writes a compliance report into `reports/`. Open it. That's what your audit deliverable looks like — generated, not handwritten. +### For development + +```bash +git clone https://github.com/Principled-Evolution/aicertify.git +cd aicertify +pip install -e . +``` + ### Minimal Python usage ```python diff --git a/README.zh-CN.md b/README.zh-CN.md index 33174f3..784d537 100644 --- a/README.zh-CN.md +++ b/README.zh-CN.md @@ -21,9 +21,10 @@

+ PyPI + 下载量 持续集成 Star 数 - 版本 0.7.0 Python 3.12+ Apache 2.0 许可证 基于 OPA 构建 @@ -46,15 +47,28 @@ ## 快速开始 +```bash +pip install aicertify +``` + +运行内置演示(克隆仓库以获取示例合约和示例代码): + ```bash git clone https://github.com/Principled-Evolution/aicertify.git cd aicertify -pip install -e . python examples/quickstart.py ``` quickstart 会将一个示例 AI 应用接入 EU AI Act 策略集,并将合规报告写入 `reports/`。打开看看 —— 这就是您的审计交付物的样貌:由系统生成,而非手工撰写。 +### 用于开发 + +```bash +git clone https://github.com/Principled-Evolution/aicertify.git +cd aicertify +pip install -e . +``` + ### 最简 Python 用法 ```python