Skip to content

Add basic Bfrescox package infrastructure#4

Merged
jared321 merged 19 commits intomainfrom
3BasicPkg
Oct 3, 2025
Merged

Add basic Bfrescox package infrastructure#4
jared321 merged 19 commits intomainfrom
3BasicPkg

Conversation

@jared321
Copy link
Contributor

@jared321 jared321 commented Oct 1, 2025 •
edited
Loading

Self-review

  • Carefully review all changes
  • Confirm that all tox tasks function correctly and are passing
    • Intentionally broke tests and confirmed correct reporting of error including nonzero error code
    • Intentionally broke style and confirmed correct reporting of error including nonzero error code
  • Install package directly from local clone & test
    • Confirm that test suite can be run on installation through Python interpreter
  • Install package directly from local clone in editable mode & test
    • Confirm that test suite can be run on installation through Python interpreter
  • Build package from source distribution and wheel manually, install, & test
    • Confirm correct, minimal contents including LICENSE
    • Confirm that test suite can be run on installation through Python interpreter
  • Check that version information is created correctly (v0.0.0 since no tags yet)
    • In wheel and source distribution names
    • python -m pydoc bfrescox
    • bfrescox.__version__
    • python -m pip list and python -m pip show bfrescox
  • Intentionally break actions and confirm that they are correctly reported as failed
    • testing and code coverage measurements on broken test
    • flake8 on bad style
  • Download and check artifacts of all new logs
  • Review logs of all new actions
  • Check that code coverage results are being posted to CodeCov and that its presentation is reasonable
  • Confirm all actions passing

@jared321 jared321 self-assigned this Oct 1, 2025
@codecov-commenter
Copy link

codecov-commenter commented Oct 1, 2025

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.

Thanks for integrating Codecov - We've got you covered ☂️

jared321 added 11 commits October 1, 2025 17:04
@jared321
(Issue #3) Add more badges
25be6a6
@jared321
(Issue #3) Add TODO.
33cf5bf
@jared321
(Issue #3) Finalize package metadata
f152589
@jared321
(Issue #3) Explicitly exclude files that should not be distributed.
bb8587e 
Since we are using setuptools-scm to manage the package's version, all files
that are managed by git are generally included in distributions by default.
Therefore, as suggested by setuptools-scm we manually exclude files unrelated to
package building/installation using MANIFEST.in.

Built and inspected source distribution manually to confirm current minimal
distributions.
@jared321
(Issue #3) Clean build reqs as part of PR review.
d53002e
@jared321
(Issue #3) Cleaning as part of PR.
1e29dc5
@jared321
(Issue #3) Cleaning as part of PR review.
eafcd35
@jared321
(Issue #3) Cleaning as part of PR review.
59550e0
@jared321
(Issue #3) Intentionally break test to check actions.
790ea39
@jared321
(Issue #3) Fix intentional breakage, but break style.
94ad74d 
All test actions correctly detected and handled the test failure.  This will see
if the style check action is configured correctly.
@jared321
(Issue #3) Fix intentional style break.
d2dfc10 
This should reset file to desired final state.  All tox tasks passing again as
expected.  All actions should be passing again as well.
@jared321 jared321 merged commit 55d9bdf into main Oct 3, 2025
4 checks passed
@jared321 jared321 mentioned this pull request Oct 3, 2025
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

@jared321 jared321

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@jared321 @codecov-commenter