-
-
Notifications
You must be signed in to change notification settings - Fork 63
Refactor package template to follow APE 17 #438
Refactor package template to follow APE 17 #438
Conversation
This comment has been minimized.
This comment has been minimized.
4531cc1
to
18b0b77
Compare
933c84b
to
2af909c
Compare
762679b
to
3430879
Compare
This is now ready for review! |
Ok I've now simplified the migration guide a bit to avoid repeating whole files when the file can just be copied over as-is from the generated template without any modifications. |
@pllim @mhvk @bsipocz - I've pushed a few more changes:
For the issue of tox not picking up the conftest.py file in time, I'd like to defer this to a follow up PR if possible. I agree that the solution of specifying the packages in Otherwise I think I've addressed all the comments so far, but let me know if I missed something! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM! But should wait for @mhvk too.
Co-Authored-By: P. L. Lim <[email protected]>
I don't think I'll have time for another detailed look today, so would suggest to just merge this - it was already great as it was and clearly is now even better! And we have follow-up issues raised already. Super-nice work! |
Merged. Thank you, all! |
👷♂️ This refactors the package template to follow the recommendations in APE 17. Specifically, the changes are:
pyproject.toml
filesetup.py
to match what we have in astropy coretox.ini
configuration fileconftest.py
In addition I have made the following changes:
use_compiled_extensions
option for cookiecutter, because now there are some changes that are required for compiled extensions even if there is no example code.include_example_cython_code
and instead rely onuse_compiled_extensions
used together withinclude_example_code
long_description
question in favor of using theREADME.rst
as is often done📖 To see a preview of the migration guide, see https://external-builds.readthedocs.io/html/astropy-package-template/438/index.html (or click 'Details' in the status checks for the RTD build)
There is still some cleanup I'd like to make to the template unrelated to APE 17, so I'll leave this to another PR. In particular, @Cadair has been doing some work creating a more generic non-astropy-specific template and as part of that has developed a nice way to test the template, but that can wait for another PR.
Preview of the rendered template: https://github.com/astrofrog/package-template/tree/preview-ape17