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

Restructure as a Python package #98

Merged
merged 70 commits into from
Sep 8, 2024

Conversation

wtbarnes
Copy link
Member

@wtbarnes wtbarnes commented Aug 23, 2024

Fixes #77
Fixes #100
Fixes #101

This PR restructures the entire repository as a Python package using pybind11. This supersedes #79.

Remaining TODOs:

.readthedocs.yml Outdated Show resolved Hide resolved
docs/conf.py Outdated Show resolved Hide resolved
docs/conf.py Outdated Show resolved Hide resolved
# Treat everything in single ` as a Python reference.
default_role = 'py:obj'

# -- Options for intersphinx extension ---------------------------------------
Copy link
Contributor

Choose a reason for hiding this comment

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

Do you want to enable nitpicky? Maybe not in this PR tho.

Copy link
Member Author

Choose a reason for hiding this comment

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

Yeah I'll leave it to a subsequent PR.

docs/conf.py Outdated Show resolved Hide resolved
pyproject.toml Outdated Show resolved Hide resolved
pyproject.toml Outdated Show resolved Hide resolved
pyproject.toml Outdated Show resolved Hide resolved
show-fixes = true
output-format = "full"

lint.select = [
Copy link
Contributor

Choose a reason for hiding this comment

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

Enable all of them!

Copy link
Contributor

@nabobalis nabobalis left a comment

Choose a reason for hiding this comment

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

A few comments/questions but looks good to me.

I did not review the Python code or the docs that closely. I have some personal formatting issues for the examples but its so minor it isn't worth the time.

wtbarnes and others added 8 commits September 5, 2024 11:53
Co-authored-by: Nabil Freij <[email protected]>
Co-authored-by: Nabil Freij <[email protected]>
Co-authored-by: Nabil Freij <[email protected]>
Co-authored-by: Nabil Freij <[email protected]>
Co-authored-by: Nabil Freij <[email protected]>
Co-authored-by: Nabil Freij <[email protected]>
Co-authored-by: Nabil Freij <[email protected]>
Co-authored-by: Nabil Freij <[email protected]>
@wtbarnes
Copy link
Member Author

wtbarnes commented Sep 5, 2024

A few comments/questions but looks good to me.

I did not review the Python code or the docs that closely. I have some personal formatting issues for the examples but its so minor it isn't worth the time.

Thanks! Always happy to do a more thorough review of the examples later on down the road. The existing examples were adapted from my old mkdocs page. I'm going to leave future and improved examples to future PRs.

@wtbarnes wtbarnes merged commit 9272fd8 into rice-solar-physics:main Sep 8, 2024
9 checks passed
@wtbarnes wtbarnes deleted the python-packaging branch September 8, 2024 17:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update CI to build wheels for all platforms Fix Windows installation on CI Provide installable binaries
4 participants