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

Prepare to release #3

Merged
merged 3 commits into from
Jul 6, 2023
Merged

Prepare to release #3

merged 3 commits into from
Jul 6, 2023

Conversation

aerorahul
Copy link
Contributor

@aerorahul aerorahul commented Jul 5, 2023

Description
This PR prepares to make a version 0.1.0 release of wxflow.
This PR:

  • adds a automation to publish the package directly to PyPI when a tag is released.
  • allows the user to directly import the module without having to know the name of .py script that the module resides in.
  • Updates README.md to provide standard installation instructions

Type of change

  • New feature (non-breaking change which adds functionality)
  • This change requires a documentation update

How Has This Been Tested?

  • pytests

Checklist

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • My changes need updates to the documentation. I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • New and existing tests pass with my changes
  • Any dependent changes have been merged and published

Natural Language :: English
Operating System :: OS Independent
Programming Language :: Python
Programming Language :: Python :: 3
Copy link
Contributor

Choose a reason for hiding this comment

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

If you specify Python :: 3 here, why do you need to include 3.7 - 3.11? My understanding was that `Python :: 3`` should cover all Python version 3 releases. Is this just decorative?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Because the underlying code will not work w/ 3.6 or below because the dependencies have become deprecated.
I urge you to try and install this w/ e.g. 3.5

Copy link
Contributor

@HenryRWinterbottom HenryRWinterbottom Jul 5, 2023

Choose a reason for hiding this comment

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

I believe you. I was just curious as to what your reasoning was here. I see you addressed this here and here. Maybe this is OK.

Copy link
Contributor

@WalterKolczynski-NOAA WalterKolczynski-NOAA left a comment

Choose a reason for hiding this comment

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

Would love to be able to say 3.7+ instead of listing every minor version, but aside from that it looks good.

@aerorahul
Copy link
Contributor Author

Feel free to scour the internet for that.

@aerorahul aerorahul merged commit 5d60cb8 into develop Jul 6, 2023
12 checks passed
@aerorahul aerorahul deleted the feature/packaging branch July 6, 2023 02:28
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.

None yet

3 participants