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

Cookiecutter updates via Cruft #100

Merged
merged 20 commits into from
Jun 15, 2023
Merged

Cookiecutter updates via Cruft #100

merged 20 commits into from
Jun 15, 2023

Conversation

Zeitsperre
Copy link
Contributor

Changes

  • Updates the boilerplate to the latest commit via cruft.
  • Several workflows have been added to make use of GitHub CI.
  • Issue templates have been added for better issue management.
  • Main testing workflow and tests have been adapted to run smoke tests.
  • Python3.7 has been dropped everywhere.
  • A Zenodo configuration has been added.
  • Two sphinx extensions have been added: sphinx-codeautolink, sphinx-copybutton
  • More badges!

If there is anything that you would like to revise/remove, please feel free to suggest changes. This is coming from a (pseudo-)automated process based on a template of my design. General comments welcome.

@Zeitsperre Zeitsperre added documentation Improvements or additions to documentation enhancement New feature or request labels Jun 13, 2023
@Zeitsperre Zeitsperre self-assigned this Jun 13, 2023
Copy link
Contributor

@juliettelavoie juliettelavoie left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Tried to run makedocs on this branch and it failed with error:
Extension error (sphinx_codeautolink.extension): Handler <bound method SphinxCodeAutoLink.create_references of <sphinx_codeautolink.extension.SphinxCodeAutoLink object at 0x1859c0700>> for event 'env-updated' threw an exception (exception: initialization of _internal failed without raising an exception)

based on https://stackoverflow.com/questions/75190844/how-to-resolve-systemerror-initialization-of-internal-failed-without-raising-a I downgraded to numpy 1.23.1 and it worked. Maybe we should pin it in the env.yml ? or do you know another way to fix it ?

.coveralls.yml Show resolved Hide resolved
.zenodo.json Show resolved Hide resolved
CONTRIBUTING.rst Outdated Show resolved Hide resolved
@Zeitsperre
Copy link
Contributor Author

based on https://stackoverflow.com/questions/75190844/how-to-resolve-systemerror-initialization-of-internal-failed-without-raising-a I downgraded to numpy 1.23.1 and it worked. Maybe we should pin it in the env.yml ? or do you know another way to fix it ?

Looks like an issue with Python3.11 and sphinx-codeautolink. Might be worth opening an issue there: https://github.com/felix-hilden/sphinx-codeautolink/issues.

It's odd since the error isn't found in the ReadTheDocs logs using the newest numpy (v1.24.3) and numba (v0.57). Could it be related to your dependencies?

@juliettelavoie
Copy link
Contributor

this was in an env python 3.9 with numba '0.53.0'. Maybe I could have updated numba instead of downgrading numpy. If RtD can build with no issue, than I guess it is okay.

@Zeitsperre
Copy link
Contributor Author

Zeitsperre commented Jun 15, 2023

This looks good. There might be a handful of small fixes to come in the next week or so (I've been updating the template pretty actively), but this is good for now!

@juliettelavoie
Copy link
Contributor

just FYI, mamba install -c conda-forge gdal was also necessary before the pip install on my mac

@Zeitsperre
Copy link
Contributor Author

This is good to merge once tests pass!

@Zeitsperre Zeitsperre merged commit f04458a into main Jun 15, 2023
7 checks passed
@Zeitsperre Zeitsperre deleted the cruft_updates branch June 15, 2023 19:35
@Zeitsperre
Copy link
Contributor Author

Forgot to update the CHANGES, so I'll add when we prepare the release!

@juliettelavoie
Copy link
Contributor

je ferais un release maintenant demain , comme on a changé des choses dans le setup, si on veut que l'installation avec pip fonctionne. @sarahclaude le moment de tester tes nouvelles connaissances de release ? :P

@Zeitsperre
Copy link
Contributor Author

Parfait, il me reste une dernière chose à changer (un dernier bug, j'espère), mais je voudrais que l'on fasse ça ensemble. Les releases après ça seront semi-automatiques !

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants