Skip to content

Bump version to 3.0.1 and clean up README formatting#98

Merged
goldlabelapps merged 2 commits intomasterfrom
staging
Apr 24, 2026
Merged

Bump version to 3.0.1 and clean up README formatting#98
goldlabelapps merged 2 commits intomasterfrom
staging

Conversation

@goldlabelapps
Copy link
Copy Markdown
Owner

This pull request updates the project version and branding, simplifies the root API endpoint, and makes minor improvements to the README.md for clarity and consistency.

Branding and Version Updates:

  • Updated the project name and branding from "Python" to "Python°" throughout the codebase and documentation, including the docstring in app/__init__.py and the root endpoint metadata in app/api/root.py. [1] [2]
  • Bumped the project version from 1 to 3.0.1 in app/__init__.py.

API Endpoint Response Simplification:

  • Simplified the root endpoint (/) in app/api/root.py to only return metadata, removing the detailed list of endpoints from the response.

Documentation Improvements:

  • Updated section headers in README.md for consistency (e.g., "Project Overview" to "Overview", "🚀 Features" to "Features").
  • Minor formatting and whitespace cleanups in README.md for readability. [1] [2]

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.
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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__ to 3.0.1 and update branding text to “Python°”.
  • Simplify GET / to return only meta (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.

Comment thread app/api/root.py
]
return {"meta": meta, "data": endpoints}

return {"meta": meta}
Copy link

Copilot AI Apr 24, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Suggested change
return {"meta": meta}
return {"meta": meta, "data": {}}

Copilot uses AI. Check for mistakes.
Comment thread app/api/root.py
"title": "Python",
"severity": "success",
"title": "Python°",
"version": __version__,
Copy link

Copilot AI Apr 24, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Suggested change
"version": __version__,
"version": __version__,
"severity": "success",
"base": base_url,

Copilot uses AI. Check for mistakes.
@goldlabelapps goldlabelapps merged commit 73c28dd into master Apr 24, 2026
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants