Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Conversation

@jorgeMFS
Copy link
Collaborator

@jorgeMFS jorgeMFS commented Jun 1, 2025

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

  • Added fully-automated PyPI publishing workflow and badges
  • Dynamic version extraction

πŸ“¦ New Release v1.0.3 – PyPI Publication, Documentation Overhaul & Tooling Improvements

n from pyproject.toml; bumped to v1.0.3

🧰 Wrappers & Core Tools

  • Centralised tool-name constants and common flag-parsing helpers
  • Implemented cache + PATH fallback for locating vcfx binaries
  • Extended wrappers to parse TSV output into typed dataclasses; added missing tools

πŸ§ͺ Tests & Code Quality

  • Migrated test suite to pytest with extensive wrapper/helper coverage
  • Added pre-commit hooks: ruff, flake8, mypy, clang-format
  • Fixed style/lint issues; ensured Python 3.10 support (graceful fallback for 3.9 via tomli)

πŸ“š Documentation

  • Re-wrote README with PyPI-centric install & usage guide
  • Added repository-structure doc, full Python-API guide, citation.cff, and changelog
  • Detailed Docker instructions and wheel-build steps

⚠️ Breaking Changes

  • Minimum supported Python version is now 3.10. (Python 3.9 works with the tomli fallback but is no longer officially supported.)
  • All wrapper classes now reside in vcfx.tools and return parsed dataclass objects.

βœ… Checklist

  • All unit tests pass: pytest -q
  • Docs build clean: make docs
  • Lint & format: pre-commit run --all-files
  • Verified successful upload to Test PyPI / live PyPI

jorgeMFS added 30 commits May 27, 2025 00:54
…ate-documentation

Add pyproject and update python install docs
…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
…r-in-python_api.md

Add PATH note for Python API tool wrappers
…search-for-vcfx_-executables

Add PATH fallback for available_tools
Improve executable path detection and fix doc lookup test
…on-flag-handling

Add unified flag handler
jorgeMFS added 22 commits May 31, 2025 23:45
…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
…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
@jorgeMFS jorgeMFS added bug Something isn't working documentation Improvements or additions to documentation enhancement New feature or request labels Jun 1, 2025
@jorgeMFS jorgeMFS added this to the First Operational VCFx Tool milestone Jun 1, 2025
This was linked to issues Jun 1, 2025
Closed
@jorgeMFS jorgeMFS self-assigned this Jun 1, 2025
@jorgeMFS jorgeMFS merged commit cf883b5 into ieeta-pt:main Jun 1, 2025
8 checks passed
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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Correct webpack running Tests

1 participant