-
Couldn't load subscription status.
- Fork 1
New Release v1.0.3 β PyPI Publication, Documentation Overhaul & Tooling Improvements
#5
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. Weβll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
β¦ate-documentation Add pyproject and update python install docs
β¦thon/tools.py Cache vcfx tool list
β¦docstrings Improve type hints and docs for tools API
β¦check-vcfx Update Python vcfx wrapper availability check
β¦ols-to-check-vcfx Update Python vcfx wrapper availability check
β¦readme Add Python API docs & fix wrapper docs path
β¦ate-__all__ Expose package version
β¦r-in-python_api.md Add PATH note for Python API tool wrappers
β¦search-for-vcfx_-executables Add PATH fallback for available_tools
Add tests for new samples option
Add citation metadata file
Update Docker docs with entrypoint usage
Improve executable path detection and fix doc lookup test
β¦on-flag-handling Add unified flag handler
β¦s before function definition (E302) - remove trailing blank line at end of file (W391)
Organize docs by category
Add repository structure section
Fix doc lookup with new directory layout
Rewrite README
- Add GitHub Actions workflow for automated PyPI publishing - Create Python package README with installation and usage info - Update pyproject.toml with improved metadata and SPDX license - Fix setup.py to handle missing CMakeLists.txt during wheel building - Add build_and_publish.py script for local publishing - Create PUBLISHING_PYPI.md documentation The package can now be published to PyPI via GitHub releases, manual workflow dispatch, or local script execution
β¦e - Fix line length issues - Remove blank lines with whitespace
- Fix 'Missing download info' error for upload-artifact@v3 - Update both upload-artifact and download-artifact to v4 - Aligns with current GitHub Actions best practices
- Build only source distributions to avoid platform tag issues - Fix version detection (was showing 0.0.0) - Extract version from CMakeLists.txt during build - Add VERSION file support for dynamic versioning - Update MANIFEST.in to include necessary files - Add PyPI setup guide documentation The package should now build with correct version and upload successfully
- Verifies version extraction and packaging - Tests that VERSION file is included correctly - Ensures package builds with proper version
- Update version extraction to match CMakeLists.txt format - Keep version as dynamic in pyproject.toml - Fix both test script and GitHub Actions workflow - Successfully tested locally: builds vcfx-1.0.2.tar.gz
β¦ilt, clean build dirs, remove wheels
β¦n compatibility
β¦ide - Expanded Python README with detailed examples, workflows, and structured data types - Moved PyPI installation to top of installation guide - Added Python API section to main docs - Enhanced Python API docs with best practices - Added Python examples to quickstart guide
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
bug
Something isn't working
documentation
Improvements or additions to documentation
enhancement
New feature or request
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This pull request rolls up all work merged between 27 May β 1 June 2025 (176 commits, 251 files touched) into the first public PyPI release.
π Packaging & Distribution
π¦ New Release
v1.0.3β PyPI Publication, Documentation Overhaul & Tooling Improvementsn from
pyproject.toml; bumped tov1.0.3π§° Wrappers & Core Tools
π§ͺ Tests & Code Quality
ruff,flake8,mypy,clang-formattomli)π Documentation
citation.cff, and changelogtomlifallback but is no longer officially supported.)vcfx.toolsand return parsed dataclass objects.β Checklist
pytest -qmake docspre-commit run --all-files