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

modernize with pyproject, use scm for version #1067

Merged
merged 1 commit into from
Oct 29, 2024
Merged

modernize with pyproject, use scm for version #1067

merged 1 commit into from
Oct 29, 2024

Conversation

ischneider
Copy link
Member

Related Issue(s):

N/A

Proposed Changes:

Modernize project metadata, use scm for versioning

Diff of User Interface

N/A

PR Checklist:

  • This PR is as small and focused as possible
  • If this PR includes proposed changes for inclusion in the changelog, the title of this PR summarizes those changes and is ready for inclusion in the Changelog.
  • I have updated docstrings for function changes and docs in the 'docs' folder for user interface / behavior changes
  • This PR does not break any examples or I have updated them

@ischneider ischneider force-pushed the pyproject branch 2 times, most recently from 10fb1c8 to 439764c Compare October 18, 2024 21:40
@asonnenschein
Copy link
Contributor

The Python version in the contributing doc should be updated to one of the supported versions with this MR (it's currently set to 3.7): https://github.com/planetlabs/planet-client-python/blob/main/CONTRIBUTING.md?plain=1#L174-L195.

__version__ = '2.11.0dev'
from importlib.metadata import version

__version__ = version("planet")
Copy link
Contributor

Choose a reason for hiding this comment

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

Slick! I haven't seen this before. From the docs it looks like version() will pull the version number of the package as a string from the pypi distribution package? Does that mean we don't have to bump the version number manually anymore and this will just pull whatever version we tag?

Copy link
Member Author

Choose a reason for hiding this comment

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

Yes, this makes releasing much simpler!

Copy link
Contributor

@asonnenschein asonnenschein left a comment

Choose a reason for hiding this comment

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

LGTM! After this MR is merged I will follow up with an update to the release process that reflects the changes to version.py. Before you merge could you update the Python version here https://github.com/planetlabs/planet-client-python/blob/main/CONTRIBUTING.md?plain=1#L174-L195 ?

replace use of python 3.7 with more recent versions
@ischneider
Copy link
Member Author

Updated various references to 3.7 with recent versions... I stuck w/ 3.12 for the git actions as this is what ubuntu-latest provides? (don't think it matters which version, as long as it runs...)

@ischneider ischneider merged commit efcb023 into main Oct 29, 2024
9 checks passed
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.

2 participants