update readme with pypi based instructions #247
Conversation
WalkthroughUpdates to documentation: README header replaced and badges added; Quick Start restructured to emphasize virtualenv + PyPI installation and a 30-second tutorial; removed nightlies/uv-centric install snippets; added a development block with uv install and pre-commit hook guidance in docs. Changes
Sequence Diagram(s)(omitted — changes are documentation-only and do not introduce new multi-component control flow) Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
README.md (1)
62-84: Consolidate code blocks for better readability. ♻️Lines 62-67 and 68-84 are separated unnecessarily, creating an awkward reading flow. The two sections are logically related (uv installation prerequisites for development setup). Consider consolidating into a single code block or adding clearer transition text.
Proposed consolidation
-For users who want to contribute to or modify Temoa should install in development mode using `uv`: - -```bash -# Install uv if you haven't already -curl -LsSf https://astral.sh/uv/install.sh | sh - -``` - -```bash -# Clone repository -git clone https://github.com/TemoaProject/temoa.git +For users who want to contribute to or modify Temoa should install in development mode using `uv`: + +```bash +# Install uv if you haven't already +curl -LsSf https://astral.sh/uv/install.sh | sh + +# Clone repository +git clone https://github.com/TemoaProject/temoa.git
🤖 Fix all issues with AI agents
In @README.md:
- Around line 20-25: Update the README's virtualenv activation snippet to
include Windows-compatible syntax or a clear cross-platform note: keep the
existing python -m venv .venv and source .venv/bin/activate lines, but add an
alternate Windows activation line (.venv\Scripts\activate) and/or a small
comment indicating which command to use on Linux/Mac vs Windows so Windows users
can follow the instructions.
- Line 1: You removed the version number from the README title which means the
README will no longer update automatically during releases; verify that your
release automation/CI (e.g., GitHub Actions, release scripts) is configured to
rely on the PyPI badge or another single source of truth, and if you want README
automation instead, add a step to your release pipeline (or a pre-commit hook)
that reads the package version from pyproject.toml or package __init__.py and
writes it into README.md (or reinstates the versioned title) so the README stays
in sync with releases.
- Line 60: Fix the grammatical error in the README intro: change the sentence
"For users who want to contribute or modify Temoa should install in development
mode using `uv`:" to "For users who want to contribute to or modify Temoa,
install it in development mode using `uv`." Ensure the added preposition "to"
and include a comma after "Temoa" for correct syntax.
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro
📒 Files selected for processing (2)
README.mddocs/source/quick_start.rst
🧰 Additional context used
🧠 Learnings (1)
📚 Learning: 2025-10-27T15:53:41.829Z
Learnt from: ParticularlyPythonicBS
Repo: TemoaProject/temoa PR: 177
File: temoa/model_checking/commodity_network.py:26-33
Timestamp: 2025-10-27T15:53:41.829Z
Learning: The Temoa project requires Python 3.12 or above as the minimum supported version, so PEP 695 `type` syntax for type aliases is appropriate and preferred over `TypeAlias`.
Applied to files:
README.md
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (4)
- GitHub Check: setup and test (macos-latest, 3.13)
- GitHub Check: setup and test (macos-latest, 3.12)
- GitHub Check: setup and test (windows-latest, 3.13)
- GitHub Check: setup and test (windows-latest, 3.12)
🔇 Additional comments (1)
docs/source/quick_start.rst (1)
15-25: Documentation updates are well-integrated and clear. ✓The restructured installation guidance appropriately emphasizes virtual environment setup and PyPI-based installation while adding the pre-commit hook step for contributors. Changes align well with the PR objective to simplify PyPI-focused workflows.
Also applies to: 31-48, 50-64
README.md
Outdated
|
|
||
| ### Development Installation | ||
|
|
||
| For users who want to contribute or modify Temoa should install in development mode using `uv`: |
There was a problem hiding this comment.
Fix grammatical error in development installation intro.
Line 60 should read: "For users who want to contribute to or modify Temoa..." (missing preposition).
Fix
-For users who want to contribute or modify Temoa should install in development mode using `uv`:
+For users who want to contribute to or modify Temoa should install in development mode using `uv`:📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| For users who want to contribute or modify Temoa should install in development mode using `uv`: | |
| For users who want to contribute to or modify Temoa should install in development mode using `uv`: |
🤖 Prompt for AI Agents
In @README.md at line 60, Fix the grammatical error in the README intro: change
the sentence "For users who want to contribute or modify Temoa should install in
development mode using `uv`:" to "For users who want to contribute to or modify
Temoa, install it in development mode using `uv`." Ensure the added preposition
"to" and include a comma after "Temoa" for correct syntax.
ParticularlyPythonicBS
force-pushed
the
docs/readme_update_pypi
branch
from
c9f1da8 to
4e61163
Compare
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Fix all issues with AI agents
In @README.md:
- Around line 67-73: Rewrite the README section to fix grammar and consolidate
the fragmented code blocks: replace the awkward sentence on contribution with
"If you want to contribute to or modify Temoa, install in development mode using
`uv`", add a "### Development Installation" heading, ensure the `bash` code
fence begins before the curl command and includes the curl install line, then
immediately follow with the next code fence containing the repository clone
command so the install and clone steps are in separate, correctly formed code
blocks; update the lines around the existing curl and subsequent code fence to
remove the stray/incomplete triple backticks and ensure proper Markdown code
block formatting.
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro
📒 Files selected for processing (2)
README.mddocs/source/quick_start.rst
🧰 Additional context used
🧠 Learnings (1)
📚 Learning: 2025-10-27T15:53:41.829Z
Learnt from: ParticularlyPythonicBS
Repo: TemoaProject/temoa PR: 177
File: temoa/model_checking/commodity_network.py:26-33
Timestamp: 2025-10-27T15:53:41.829Z
Learning: The Temoa project requires Python 3.12 or above as the minimum supported version, so PEP 695 `type` syntax for type aliases is appropriate and preferred over `TypeAlias`.
Applied to files:
README.md
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (4)
- GitHub Check: setup and test (windows-latest, 3.12)
- GitHub Check: setup and test (windows-latest, 3.13)
- GitHub Check: setup and test (macos-latest, 3.13)
- GitHub Check: setup and test (macos-latest, 3.12)
🔇 Additional comments (3)
docs/source/quick_start.rst (1)
11-65: Strong alignment with stated objectives.The restructuring effectively emphasizes PyPI-based installation and removes nightlies/uv-centric guidance. The addition of pre-commit installation (line 62-63) aligns with modern contribution workflows. The changes are clear and well-organized, distinguishing between standard installation, uv alternative, and development setup.
README.md (2)
1-10: Badges provide clear project status indicators.The badge suite (PyPI, CI, documentation, Python version, license, type checking, linters) effectively communicates project maturity and quality standards. The badges link to relevant resources (PyPI, GitHub Actions, ReadTheDocs) and follow standard conventions.
Please verify that all badge endpoints are accessible and rendering correctly, particularly the Ruff and uv badges which rely on external JSON endpoints. You can test by visiting the URLs directly or confirming the badges display correctly once the PR is merged.
18-44: Clear, well-structured installation and quick-start guidance.The restructuring effectively addresses the PR objective by emphasizing virtual environment setup and PyPI installation as the standard path. The "Get Started in 30 Seconds" section (lines 34-44) provides excellent quick onboarding for new users, balancing between detailed setup and immediate utility.
| For users who want to contribute to or modify Temoa should install in development mode using `uv`: | ||
|
|
||
| ```bash | ||
| # Install uv if you haven't already | ||
| curl -LsSf https://astral.sh/uv/install.sh | sh | ||
|
|
||
| ``` |
There was a problem hiding this comment.
Fix grammar and code block formatting.
Line 67 contains awkward phrasing. Additionally, the code block structure appears fragmented with an incomplete block between lines 69-73 and the next block at line 75.
✏️ Proposed fix
-### Development Installation
-
-For users who want to contribute to or modify Temoa should install in development mode using `uv`:
-
-```bash
-# Install uv if you haven't already
-curl -LsSf https://astral.sh/uv/install.sh | sh
-
-```
+### Development Installation
+
+If you want to contribute to or modify Temoa, install in development mode using `uv`:
+
+```bash
+# Install uv if you haven't already
+curl -LsSf https://astral.sh/uv/install.sh | sh
```bash
# Clone repository🤖 Prompt for AI Agents
In @README.md around lines 67 - 73, Rewrite the README section to fix grammar
and consolidate the fragmented code blocks: replace the awkward sentence on
contribution with "If you want to contribute to or modify Temoa, install in
development mode using `uv`", add a "### Development Installation" heading,
ensure the `bash` code fence begins before the curl command and includes the
curl install line, then immediately follow with the next code fence containing
the repository clone command so the install and clone steps are in separate,
correctly formed code blocks; update the lines around the existing curl and
subsequent code fence to remove the stray/incomplete triple backticks and ensure
proper Markdown code block formatting.
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.