Skip to content
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

Project Infrastructure Setup (Phase 1) #29

Closed
27 tasks done
PPeitsch opened this issue Nov 25, 2024 · 0 comments · Fixed by #31, #32, #33, #35 or #36
Closed
27 tasks done

Project Infrastructure Setup (Phase 1) #29

PPeitsch opened this issue Nov 25, 2024 · 0 comments · Fixed by #31, #32, #33, #35 or #36

Comments

@PPeitsch
Copy link
Owner

PPeitsch commented Nov 25, 2024

Project Infrastructure Setup (Phase 1)

Objective

Set up the initial project infrastructure to support modern Python packaging, automated testing, and quality assurance.

Tasks

1. GitHub Repository Structure

  • Set up .github/workflows/
    • Create test-and-publish.yaml for CI/CD
  • Set up .github/ISSUE_TEMPLATE/
    • Add bug.yaml
    • Add feature.yaml
    • Add docs.yaml
    • Add config.yaml
  • Add root GitHub files
    • Add CODE_OF_CONDUCT.md
    • Add CONTRIBUTING.md
    • Add SECURITY.md
    • Add PULL_REQUEST_TEMPLATE.md

2. Modern Python Packaging

  • Create pyproject.toml with build configuration
  • Move to src-layout
    • Create src/pkynetics/ directory
    • Move existing code to new structure
    • Update __init__.py files

3. Code Quality Tools

  • Configure Black for code formatting
  • Configure isort for import sorting
  • Set up mypy configuration
  • Configure pytest
  • Set up Coverage.py

Implementation Notes

  1. This is a breaking change and will be part of v1.0.0
  2. Dependencies will be updated to use newer package versions
  3. All configuration files will use modern standards
  4. CI/CD pipeline will be set up to run on Python 3.9, 3.10, and 3.11

Success Criteria

  • All CI workflows pass
  • Package builds successfully
  • Tests run on all Python versions
  • Code quality checks pass
  • Documentation builds correctly

Related Issues

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment