Release v0.1.1: Minor improvements and documentation updates #21
Conversation
…on extraction and clean build artifacts
- Update version to 0.1.1 in version.py - Update CHANGELOG.md with v0.1.1 release notes - Document recent improvements and changes
There was a problem hiding this comment.
Pull Request Overview
This PR prepares the v0.1.1 release of Kaira by updating the Python version requirement, refining documentation, and cleaning up configuration files and deployment scripts. Key changes include:
- Updating the Python version requirement from ">=3.8" to ">=3.10" across multiple files and bumping the package version.
- Revising documentation and installation instructions to use "pykaira" and updating the package description.
- Removing obsolete CI/CD, changelog automation, and documentation build configuration files, and enhancing the deployment script with new command-line flags and cleanup routines.
Reviewed Changes
Copilot reviewed 12 out of 12 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| tests/test_setup.py | Updated Python version requirement checks |
| setup.py | Revised Python version, package description, and topic classifiers |
| scripts/deploy.sh | Added command-line flags for deployment control and enhanced cleanup steps |
| kaira/version.py | Bumped version tuple from (0, 1, 0) to (0, 1, 1) |
| docs/introduction.rst & getting_started.rst | Updated installation command from "pip install kaira" to "pip install pykaira" |
| README.md | Updated logo URL asset reference |
| CHANGELOG.md | Added release notes for version v0.1.1 |
| .readthedocs.yaml, .github/scripts/update_changelog.py, .github/release-drafter.yml, .circleci/config.yml | Removed obsolete configuration and automation files |
Comments suppressed due to low confidence (1)
.github/scripts/update_changelog.py:1
- Ensure that the removal of the changelog update script is intentional and that its functionality is now handled by an alternative process.
#!/usr/bin/env python3
Welcome to Codecov 🎉Once you merge this PR into your default branch, you're all set! Codecov will compare coverage reports and display results in all future pull requests. ℹ️ You can also turn on project coverage checks and project coverage reporting on Pull Request comment Thanks for integrating Codecov - We've got you covered ☂️ |
- Add comprehensive usage/help function to scripts/deploy.sh - Include -h flag for displaying help message - Improve error messages with reference to help option - Add note in CHANGELOG.md clarifying intentional removal of changelog script Addresses feedback from Copilot AI code review.
There was a problem hiding this comment.
Pull Request Overview
This PR prepares the v0.1.1 release by updating compatibility, improving documentation, and cleaning up outdated CI/deployment scripts.
- Bumped minimum Python requirement to 3.10 across setup, tests, and metadata.
- Fixed installation commands (
pip install pykaira) and updated asset URLs in docs and README. - Removed legacy CI/config scripts and enhanced the deployment script with CLI flags and artifact cleanup.
Reviewed Changes
Copilot reviewed 12 out of 12 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| tests/test_setup.py | Updated expected python_requires value to >=3.10 in tests |
| setup.py | Bumped python_requires, refined description and Trove classifiers |
| scripts/deploy.sh | Added -s/-f flags, switched version source, and expanded cleanup |
| kaira/version.py | Incremented __version_info__ to (0, 1, 1) |
| docs/introduction.rst | Changed pip install to pykaira |
| docs/getting_started.rst | Changed pip install to pykaira |
| README.md | Updated logo URL to use raw GitHub path |
| CHANGELOG.md | Added new release section for v0.1.1 |
| .readthedocs.yaml | Removed Read the Docs configuration file |
| .github/scripts/update_changelog.py | Removed automatic changelog updater script |
| .github/release-drafter.yml | Removed Release Drafter configuration |
| .circleci/config.yml | Removed CircleCI pipeline configuration |
Comments suppressed due to low confidence (1)
.readthedocs.yaml:1
- Removing the Read the Docs configuration file may break automated documentation builds. Ensure that the project’s documentation build settings are migrated to an alternative config or that Read the Docs is configured correctly via the UI.
(entire file removed)
| "Operating System :: Microsoft :: Windows", | ||
| "Topic :: Scientific/Engineering :: Artificial Intelligence", | ||
| "Topic :: Scientific/Engineering :: Telecommunications", | ||
| "Topic :: Communications", |
There was a problem hiding this comment.
The classifier "Topic :: Communications" is not an official PyPI Trove classifier. If you intend to categorize under communications, use the official "Topic :: Scientific/Engineering :: Telecommunications" classifier.
| "Topic :: Communications", | |
| "Topic :: Scientific/Engineering :: Telecommunications", |
| done | ||
|
|
||
| # Extract version from kaira/version.py which is the source of truth for version number | ||
| VERSION=$(python3 -c "import sys; sys.path.append('..'); from kaira.version import __version__; print(__version__)") |
There was a problem hiding this comment.
Hardcoding a relative path for sys.path.append may break if the script is executed from a different working directory. Consider dynamically deriving the project root using $(dirname "$0") to ensure correct path resolution.
| VERSION=$(python3 -c "import sys; sys.path.append('..'); from kaira.version import __version__; print(__version__)") | |
| SCRIPT_DIR=$(dirname "$0") | |
| PROJECT_ROOT=$(realpath "$SCRIPT_DIR/..") | |
| VERSION=$(python3 -c "import sys; sys.path.append('$PROJECT_ROOT'); from kaira.version import __version__; print(__version__)") |
Release v0.1.1
This pull request merges the dev branch to main to release version 0.1.1 of Kaira.
Changes in this release:
🔧 Configuration Updates
📖 Documentation Improvements
🧹 Code Cleanup
📋 Project Maintenance
Version Information:
Testing:
Files Changed:
kaira/version.py- Version bump to 0.1.1CHANGELOG.md- Added release notes for v0.1.1This is a minor release focusing on improvements and fixes without introducing new features.