Skip to content

Align package structure with scientific-python template #16

New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

#

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Jump to bottom
Merged
merged 55 commits into from
Apr 23, 2025
Merged

Align package structure with scientific-python template #16

merged 55 commits into from
Apr 23, 2025

Conversation

Alexboiboi
Copy link
Member

@Alexboiboi Alexboiboi commented Apr 13, 2025 •
edited
Loading

This pull request restructures the package to follow the scientific-python cookie template provided by https://scientific-python.org/, updating documentation, CI/CD, and packaging configurations.

Key changes include:

  • Removal of legacy README sections and addition of updated badges and warning notices.
  • Modernization of CI/CD workflows (pre-commit, GitHub Actions, CD for PyPI publishing).
  • Updates to the CHANGELOG and contributor guidelines to reflect the new structure.

To be covered later:

  • mypy type checking
  • pylint specific errors muted (check TODOs)

Alexboiboi and others added 28 commits April 13, 2025 10:29
@Alexboiboi
draft
9cbb630
@pre-commit-ci
style: pre-commit fixes
dead26c
@Alexboiboi
improve dataset handling and package data inclusion
b9d4584
@Alexboiboi
pre-commit run
248943d
@Alexboiboi
Merge branch 'use-scientific-python-pypackage-base' of https://github…
fe11363 
….com/magpylib/magpylib-material-response into use-scientific-python-pypackage-base
@pre-commit-ci
style: pre-commit fixes
bca6daa
@Alexboiboi
readd deps
4b245a2
@Alexboiboi
readd doc examples
c73d941
@pre-commit-ci
style: pre-commit fixes
e3f489e
@Alexboiboi
readd myst_nb
eed217f
@Alexboiboi
Merge branch 'use-scientific-python-pypackage-base' of https://github…
80fc5b1 
….com/magpylib/magpylib-material-response into use-scientific-python-pypackage-base
@pre-commit-ci
style: pre-commit fixes
15280a9
@Alexboiboi
add myst_nb
2084ef1
@Alexboiboi
Merge branch 'use-scientific-python-pypackage-base' of https://github…
2efa4cc 
….com/magpylib/magpylib-material-response into use-scientific-python-pypackage-base
@Alexboiboi
remove uv.lock
066748a
@Alexboiboi
fix linting errors
f839e31
@Alexboiboi
typing
f7d96ff
@pre-commit-ci
style: pre-commit fixes
2610a9e
@Alexboiboi
remove mypy checks for now
c5c7d2e
@Alexboiboi
avoid W005 — Wheel contains common toplevel name in library
3e85eab
@pre-commit-ci
style: pre-commit fixes
16b134b
@Alexboiboi
add hatch configs
144d81d
@Alexboiboi
update
ce87784
@Alexboiboi
add myst extensions
9c78fd5
@Alexboiboi
update docs deps
7cdf1f3
@pre-commit-ci
style: pre-commit fixes
f8e6f76
@Alexboiboi
ignore jupyter notebook files
4c562f9
@Alexboiboi
fix get_dataset
1daa641
@Alexboiboi Alexboiboi changed the title Align package structure from scientific-python template Align package structure with scientific-python template Apr 18, 2025
@Alexboiboi Alexboiboi requested a review from Copilot April 18, 2025 20:58
Copilot

This comment was marked as duplicate.

# to view

Alexboiboi and others added 3 commits April 18, 2025 23:00
@Alexboiboi @Copilot
Update CHANGELOG.md
4d9c4f8 
typo

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@Alexboiboi @Copilot
Update CHANGELOG.md
196af46 
typo

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@pre-commit-ci
style: pre-commit fixes
b7c6240
@Alexboiboi Alexboiboi merged commit 7cf01be into main Apr 23, 2025
15 checks passed
@Alexboiboi Alexboiboi deleted the use-scientific-python-pypackage-base branch April 23, 2025 06:53
# for free to join this conversation on GitHub. Already have an account? # to comment
Reviewers

Copilot code review Copilot Copilot left review comments

@OrtnerMichael OrtnerMichael Awaiting requested review from OrtnerMichael

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

Successfully merging this pull request may close these issues.
1 participant
@Alexboiboi