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

Pip Install ParaStell #92

Open
connoramoreno opened this issue Apr 25, 2024 · 10 comments
Open

Pip Install ParaStell #92

connoramoreno opened this issue Apr 25, 2024 · 10 comments
Assignees

Comments

@connoramoreno
Copy link
Collaborator

connoramoreno commented Apr 25, 2024

Rather than manually generate executables, put ParaStell on paths, etc., making ParaStell pip-installable would streamline much of the installation process.

See this tutorial on packaging. Most of this issue will be resolved by generating a pyproject.toml file: https://packaging.python.org/en/latest/guides/writing-pyproject-toml/#writing-pyproject-toml

@connoramoreno connoramoreno self-assigned this Apr 25, 2024
@paulromano
Copy link
Collaborator

@connoramoreno If you haven't started working on this, I can take a shot at putting together a pyproject.toml file

@connoramoreno
Copy link
Collaborator Author

@paulromano Please feel free! That would be very helpful

@Edgar-21
Copy link
Contributor

Edgar-21 commented Aug 4, 2024

We should look at including black formatting args in the pyproject.toml as well.

@MicahGale
Copy link

I could tackle this if you want. I'm thinking we should we tag this as "alpha" for now, so we can avoid semantic versioning for the time being. It sounds like too many breaking changes are occurring that doing major releases for each would be too much of a burden for now.

@MicahGale
Copy link

Also is there interest in setting up a GitHub action to deploy to PyPI?

@connoramoreno
Copy link
Collaborator Author

If you don't mind, that would be very helpful @MicahGale! Given the substantial changes that are typical for many ParaStell PRs, I think a GitHub action for PyPI would make sense, at least for the time being.

@MicahGale MicahGale self-assigned this Mar 5, 2025
@MicahGale
Copy link

@connoramoreno I may ping you for metadata I can't find then.

@MicahGale
Copy link

I noticed this executable: https://github.com/svalinn/parastell/blob/main/executables/parastell. If I made this so you got a parastell command that you get when you install parastell, can we remove this? I may add a backup so you could also run python -m parastell to accomplish the same thing.

@connoramoreno
Copy link
Collaborator Author

connoramoreno commented Mar 5, 2025

It may be unnecessary to provide this context, but the primary (intended) way to use ParaStell functionality is via importing it as a module in a Python script. The parastell executable, in conjunction with a YAML file giving ParaStell input, is meant as an alternative for those who prefer a command-line interface or who want to pass around ParaStell input (without a script).

If it would be possible to accomplish the same functionality without the executable file, I'm open to it!

@MicahGale
Copy link

Sweet. I'll role with it then.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants