Skip to content

Plan core library package release#90

Merged
skyelaird merged 1 commit intomainfrom
claude/plan-library-release-01HMZvCmY9n7V6tvNCN4UAbU
Nov 16, 2025
Merged

Plan core library package release#90
skyelaird merged 1 commit intomainfrom
claude/plan-library-release-01HMZvCmY9n7V6tvNCN4UAbU

Conversation

@skyelaird
Copy link
Copy Markdown
Owner

Two-product architecture:

  1. dvoacap library (PyPI package for developers)
  2. DVOACAP Dashboard (web app for end-users)

Library changes:

  • Fix version consistency: 0.9.0 in both pyproject.toml and init.py
  • Add MANIFEST.in for proper source distribution
  • Move DVoaData inside package (src/dvoacap/DVoaData/)
  • Update FourierMaps to find data files in package location
  • Configure package_data in pyproject.toml
  • Test build successful: wheels include all .dat files

Dashboard deployment:

  • Add Dockerfile for containerized deployment
  • Add docker-compose.yml for easy orchestration
  • Add .dockerignore to optimize image size

Documentation:

  • Create comprehensive PYPI_RELEASE_GUIDE.md
  • Document release process, versioning strategy
  • Include deployment options for both products

Build verified:

  • Source tarball: 884K (includes DVoaData/)
  • Wheel: 71K + 24 data files
  • All CCIR/URSI coefficient files packaged correctly

Description

A clear and concise description of what this PR does.

Type of Change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation update
  • Performance improvement
  • Code refactoring
  • Test coverage improvement

Related Issues

Closes #(issue number)
Related to #(issue number)

Changes Made

  • Change 1
  • Change 2
  • Change 3

Testing

Describe the tests you've run to verify your changes:

Test Configuration

  • Python version:
  • Operating System:
  • NumPy/SciPy versions:

Test Results

# Command used to test
python -m pytest tests/

# Or validation command
python test_voacap_reference.py
  • All existing tests pass
  • New tests added for new functionality
  • Validation pass rate maintained or improved
  • No performance regression

Validation Checklist

  • Code follows PEP 8 style guidelines
  • Docstrings added/updated for public functions
  • Type hints added where appropriate
  • Comments added for complex logic
  • Documentation updated (README, USAGE, etc.)
  • CHANGELOG.md updated
  • No new warnings or errors introduced

Performance Impact

  • No performance impact
  • Performance improved (provide benchmarks)
  • Minor performance regression (justified because...)
  • Not applicable

Benchmarks (if applicable)

Before: X seconds
After: Y seconds
Change: Z% improvement/regression

Breaking Changes

If this PR introduces breaking changes, describe:

  1. What breaks
  2. Migration path for users
  3. Why this change is necessary

Screenshots/Output (if applicable)

For dashboard changes or output format changes, include before/after screenshots or sample output.

Additional Notes

Any additional information that reviewers should know:

  • Assumptions made
  • Trade-offs considered
  • Future work needed
  • Dependencies added/removed

Reviewer Checklist

For maintainers reviewing this PR:

  • Code quality is acceptable
  • Tests are comprehensive
  • Documentation is clear
  • Validation results are acceptable
  • No security issues introduced
  • Backward compatibility maintained (or breaking changes justified)

Two-product architecture:
1. dvoacap library (PyPI package for developers)
2. DVOACAP Dashboard (web app for end-users)

Library changes:
- Fix version consistency: 0.9.0 in both pyproject.toml and __init__.py
- Add MANIFEST.in for proper source distribution
- Move DVoaData inside package (src/dvoacap/DVoaData/)
- Update FourierMaps to find data files in package location
- Configure package_data in pyproject.toml
- Test build successful: wheels include all .dat files

Dashboard deployment:
- Add Dockerfile for containerized deployment
- Add docker-compose.yml for easy orchestration
- Add .dockerignore to optimize image size

Documentation:
- Create comprehensive PYPI_RELEASE_GUIDE.md
- Document release process, versioning strategy
- Include deployment options for both products

Build verified:
- Source tarball: 884K (includes DVoaData/)
- Wheel: 71K + 24 data files
- All CCIR/URSI coefficient files packaged correctly
@skyelaird skyelaird merged commit 63e9cd9 into main Nov 16, 2025
6 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