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 and add packaging metadata #6

Closed
wants to merge 7 commits into from

Conversation

adigitoleo
Copy link
Member

@adigitoleo adigitoleo commented Jan 25, 2021

closes #5

TODO:

  • Add version ranges in install_requires (setup.cfg)
  • Specify parallelism framework dependency
  • Check that shell scripts are found by console_scripts (setup.cfg)
    Using scripts = specifier instead
  • Use setuptools_scm to source package version from git tags

@adigitoleo adigitoleo marked this pull request as ready for review January 27, 2021 07:37
@adigitoleo adigitoleo marked this pull request as draft January 27, 2021 09:41
@adigitoleo adigitoleo marked this pull request as ready for review January 27, 2021 09:48
@adigitoleo
Copy link
Member Author

Eventually the README can be updated with new installation instructions:

  1. Bare minimum, using multiprocessing from stdlib: pip install pydrex
  2. With a third party multiprocessing library, e.g. pip install pydrex[ray]
  3. With ray, matplotlib and SVML support: pip install pydrex[ray,plot,svml]

For now, it's not on PyPI so the installation should work like this:

  1. Clone/download source files
  2. Navigate to source root (where the setup.cfg is)
  3. Run pip install .[ray,plot,svml] (i.e. replace pydrex with . in the above)

That should get the dependencies and set up an importable python package called pydrex.

@adigitoleo adigitoleo marked this pull request as draft January 27, 2021 10:27
@adigitoleo
Copy link
Member Author

Not quite ready, pip is yelling at me about a few things...

@adigitoleo
Copy link
Member Author

OK should be good to go now

@adigitoleo adigitoleo marked this pull request as ready for review January 27, 2021 11:50
@adigitoleo
Copy link
Member Author

Closing until the Next Big Rewrite (TM), there's a lot more to do before packaging.

@adigitoleo adigitoleo closed this Jul 22, 2021
@adigitoleo adigitoleo deleted the feature/5-packaging-meta branch March 28, 2022 08:36
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.

Set up packaging metadata
1 participant