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

Packaging fixes #245

Merged
merged 18 commits into from
Mar 18, 2024
Merged

Packaging fixes #245

merged 18 commits into from
Mar 18, 2024

Conversation

Zeitsperre
Copy link
Contributor

@Zeitsperre Zeitsperre commented Mar 14, 2024

Overview

Changes:

  • Restructures the package so that the wheel does not install the testing and docs as non-importable packages
  • Ensured that data required to run tests and build docs is present in the source distribution (via Manifest.in changes)
  • Documentation now includes a sphinx-apidoc-based listing of all installed modules and functions
  • Added sphinx-copybutton and sphinx-codeautolink in order to increase the usefulness of code-blocks in the example documentation (copying of code blocks and ability to click on birdy objects and go straight to the documentation entry for the object)
  • All the documentation build warnings have been addressed
  • Added the birdy[extra] pip install recipe to be able to install all extras needed more directly
  • Raised the minimum Python required to 3.9 in the setup block
  • Removed the Python package for pandoc (unmaintained)
  • Added a documentation entry on using build to build the documentation.

Related Issue / Discussion

The changes here make it so that running the tests requires that the package is installed, as tests are no longer seen as part of the installed package. This reduces the size of the wheel significantly, while also making it so that source distributions have all the required files to run tests (good for conda-forge).

Eventually, it would be good to migrate this package to pyproject.toml to simplify/centralize a lot of these configurations, but this is fine for now.

Additional Information

@cehbrecht Would it make sense to perform another release after this? The changes are relatively significant to the packaging, but doesn't touch the core logic. Perhaps another patch release? I leave that decision up to you.

@Zeitsperre Zeitsperre self-assigned this Mar 15, 2024
@Zeitsperre Zeitsperre requested a review from cehbrecht March 15, 2024 16:32
@Zeitsperre Zeitsperre marked this pull request as ready for review March 15, 2024 16:33
MANIFEST.in Outdated Show resolved Hide resolved
@cehbrecht
Copy link
Member

Thanks for cleaning up birdy 🙂 Looks good 👍

Would it make sense to perform another release after this? The changes are relatively significant to the packaging, but doesn't touch the core logic. Perhaps another patch release? I leave that decision up to you.

I think a new release is worth it.

@Zeitsperre Zeitsperre merged commit 76dfa35 into master Mar 18, 2024
7 checks passed
@Zeitsperre Zeitsperre deleted the packaging-fixes branch March 18, 2024 15:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants