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.

Sign up for GitHub

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

Jump to bottom

refactor: update packaging content + better site infra #240

Merged
merged 6 commits into from
Aug 14, 2024
Merged

refactor: update packaging content + better site infra #240

merged 6 commits into from
Aug 14, 2024

Conversation

Saransh-cpp
Copy link
Member

@Saransh-cpp Saransh-cpp commented Aug 12, 2024 •
edited
Loading

Closes #237
Closes #196

Packaging contents update:

  • More resources (packaging guides, cookie templates, more backend descriptions)
  • Use hatch instead of setuptools
  • Follow a different (src) directory structure (match it with scientific python's guidelines)
  • Some more information about VCS versioning, optional dependencies, ...

Site infra updates:

  • Get rid of old and archived actions
  • Use the new GitHub sites build instead of gh-pages
  • Upload the generated site as an artifact to preview it locally for validation

@Saransh-cpp Saransh-cpp marked this pull request as draft August 12, 2024 12:48
Saransh-cpp
Saransh-cpp commented Aug 12, 2024
View reviewed changes
.github/workflows/build_site.yml Outdated Show resolved Hide resolved
.github/workflows/build_site.yml Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@Saransh-cpp Saransh-cpp marked this pull request as ready for review August 12, 2024 13:20
@Saransh-cpp Saransh-cpp requested a review from dpshelio August 12, 2024 13:20
@Saransh-cpp Saransh-cpp mentioned this pull request Aug 12, 2024
Merged
dpshelio
dpshelio requested changes Aug 12, 2024
View reviewed changes
Copy link
Member

@dpshelio dpshelio left a comment

Choose a reason for hiding this comment

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

Amazing job! 🚀 Love it all, including all the changes to the gh-actions.
I've got a couple of comments about the new file structure and the introduction on package repositories.

ch04packaging/03Packaging.ipynb.py Outdated Show resolved Hide resolved
ch04packaging/03Packaging.ipynb.py Show resolved Hide resolved
ch04packaging/03Packaging.ipynb.py Outdated Show resolved Hide resolved
ch04packaging/03Packaging.ipynb.py Outdated Show resolved Hide resolved
ch04packaging/03Packaging.ipynb.py Show resolved Hide resolved
ch04packaging/03Packaging.ipynb.py Show resolved Hide resolved
ch04packaging/03Packaging.ipynb.py Outdated Show resolved Hide resolved
ch04packaging/03Packaging.ipynb.py Outdated Show resolved Hide resolved
ch04packaging/03Packaging.ipynb.py Outdated Show resolved Hide resolved
dpshelio
dpshelio reviewed Aug 12, 2024
View reviewed changes
ch04packaging/03Packaging.ipynb.py
Comment on lines +37 to +39
# Finally, the packaging community regularly organises [PackagingCon](https://packaging-con.org) to discuss the packaging ecosystems
# of multiple languages and operating systems at a single place.
#
Copy link
Member

Choose a reason for hiding this comment

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

😍

Saransh-cpp and others added 2 commits August 12, 2024 16:38
@Saransh-cpp @dpshelio
More src migration + format
0ad1797 
Co-authored-by: David Pérez-Suárez <d.perez-suarez@ucl.ac.uk>
@Saransh-cpp
better package managers and repo + no __init__ and exclude
ee3c6ff
@Saransh-cpp Saransh-cpp force-pushed the saransh/revamp-packaging branch from d060af6 to ee3c6ff Compare August 13, 2024 11:17
@Saransh-cpp Saransh-cpp requested a review from dpshelio August 13, 2024 11:22
dpshelio
dpshelio approved these changes Aug 14, 2024
View reviewed changes
Copy link
Member

@dpshelio dpshelio left a comment

Choose a reason for hiding this comment

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

🙌

@dpshelio dpshelio merged commit 7fc11f8 into main Aug 14, 2024
4 checks passed
@dpshelio dpshelio deleted the saransh/revamp-packaging branch August 14, 2024 13:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@dpshelio dpshelio dpshelio approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Check packaging information is up to date on notes and exercises Mention of conference about packaging
2 participants
@Saransh-cpp @dpshelio