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

Updates python version in pyproject.toml and removes requirements.txt #344

Merged

Conversation

Rdbaker
Copy link
Contributor

@Rdbaker Rdbaker commented Feb 14, 2024

Purpose

This change:

  • updates the versions of the python requirement to align with PUDL, so that this module can be installed
  • removes the unused requirements.txt file, since we have 3 other dependency management files in this repo (correct me if we want that, but it wasn't referenced in the README at all)

What the code is doing

updating the python version in pyproject.toml

Testing

I will test this change by trying to install it in Greta

Where to look

n/a

Usage Example/Visuals

n/a

Review estimate

5 minutes

Future work

none for this change

Checklist

  • Update the documentation to reflect changes made in this PR
  • Format all updated python files using black
  • Clear outputs from all notebooks modified
  • Add docstrings and type hints to any new functions created

@Rdbaker
Copy link
Contributor Author

Rdbaker commented Feb 14, 2024

tested that it was able to be installed in Greta

@grgmiller
Copy link
Collaborator

Right now the target branch is main - if we test integration using this branch and everything works, we can merge directly into main and do a v0.3.2 release of OGE; otherwise, we probably want to first merge into development in case there are any other patch changes we need to make during the testing process for integration.

@grgmiller
Copy link
Collaborator

If we update the version, this also needs to be updated in the CITATION.cff file along with the release date.

@Rdbaker
Copy link
Contributor Author

Rdbaker commented Feb 14, 2024

If we update the version, this also needs to be updated in the CITATION.cff file along with the release date.

why are we using both CITATION.cff and pyproject.toml to specify the version?

@grgmiller
Copy link
Collaborator

why are we using both CITATION.cff and pyproject.toml to specify the version?

I think they serve different purposes. the citation file is to help with the citability for academic purposes, so the version number is specified there as well. https://citation-file-format.github.io/

Copy link
Collaborator

@grgmiller grgmiller left a comment

Choose a reason for hiding this comment

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

We

pyproject.toml Show resolved Hide resolved
Copy link
Collaborator

@grgmiller grgmiller left a comment

Choose a reason for hiding this comment

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

Looks good

@grgmiller grgmiller merged commit f265b3d into main Feb 14, 2024
2 checks passed
@grgmiller grgmiller deleted the ryanbaker/car-3785-install-greta-and-test-integration-works branch February 14, 2024 23:59
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