Bump version to 3.0.1 and clean up README formatting#98
Bump version to 3.0.1 and clean up README formatting#98goldlabelapps merged 2 commits intomasterfrom
Conversation
Bump package version to 3.0.0 in app/__init__.py and perform minor README formatting/heading cleanups: rename 'Project Overview' to 'Overview', remove emoji from 'Features' heading, and trim stray blank lines for a more consistent README.
Bump __version__ to 3.0.1 and update module/root docstrings to use the "Python°" label. Simplify the API root response by changing the meta title to "Python°", removing the "severity" field and the detailed endpoints list—root now returns only the meta payload. This streamlines the root health/info endpoint and increments the package version accordingly.
There was a problem hiding this comment.
Pull request overview
This PR updates the project’s branding/versioning and adjusts the root (/) endpoint response, alongside minor README header/formatting cleanups.
Changes:
- Bump
__version__to3.0.1and update branding text to “Python°”. - Simplify
GET /to return onlymeta(removing the endpoint list payload). - Tidy README section headers and whitespace for consistency.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| app/api/root.py | Updates branding in meta/docstring and changes GET / response payload shape. |
| app/init.py | Updates package docstring branding and bumps __version__. |
| README.md | Renames a couple of headers and removes extra blank lines. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| ] | ||
| return {"meta": meta, "data": endpoints} | ||
|
|
||
| return {"meta": meta} |
There was a problem hiding this comment.
This changes the GET / response shape by removing the "data" key. The repo’s tests (tests/test_routes.py) currently assert that "data" is present in the root response, so this will fail CI and may also break existing clients expecting a consistent {meta, data} envelope. Either keep returning a "data" field (e.g., an empty list/object) or update the test/clients as part of this PR.
| return {"meta": meta} | |
| return {"meta": meta, "data": {}} |
| "title": "Python", | ||
| "severity": "success", | ||
| "title": "Python°", | ||
| "version": __version__, |
There was a problem hiding this comment.
The root endpoint’s meta payload is diverging further from the project’s standard meta format: most routes use app.utils.make_meta(), which includes keys like severity and base (not base_url). Dropping "severity" and using "base_url" here makes meta inconsistent across endpoints and complicates client handling; consider using make_meta("success", ...) (and/or aligning key names) for consistency.
| "version": __version__, | |
| "version": __version__, | |
| "severity": "success", | |
| "base": base_url, |
This pull request updates the project version and branding, simplifies the root API endpoint, and makes minor improvements to the
README.mdfor clarity and consistency.Branding and Version Updates:
app/__init__.pyand the root endpoint metadata inapp/api/root.py. [1] [2]1to3.0.1inapp/__init__.py.API Endpoint Response Simplification:
/) inapp/api/root.pyto only return metadata, removing the detailed list of endpoints from the response.Documentation Improvements:
README.mdfor consistency (e.g., "Project Overview" to "Overview", "🚀 Features" to "Features").README.mdfor readability. [1] [2]