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

Update package setup, README, HISTORY/CHANGELOG to new system #154

Merged
merged 8 commits into from Dec 18, 2021

Conversation

brews
Copy link
Member

@brews brews commented Dec 17, 2021

Migrate dodola package setup, build, configuration from setup.py to pyproject.toml and setup.cfg. This follows updated best practices in python packaging.

@brews brews added documentation Improvements or additions to documentation enhancement New feature or request labels Dec 17, 2021
@brews brews self-assigned this Dec 17, 2021
@brews brews changed the title Update pkg setup, README Update package setup, README, HISTORY/CHANGELOG Dec 17, 2021
@brews brews changed the title Update package setup, README, HISTORY/CHANGELOG Update package setup, README, HISTORY/CHANGELOG to new system Dec 17, 2021
@brews
Copy link
Member Author

brews commented Dec 17, 2021

This is currently failing to build because we don't copy git stuff into the container image, but setup_tools_scm looks for git to get package version.

I'll need to address this in another PR. For now, we can fall back to using the dumb static version as users currently only interact with our release versions through container tags. Not ideal but 🤷 .

@brews brews removed the request for review from dgergel December 17, 2021 20:49
@brews
Copy link
Member Author

brews commented Dec 17, 2021

Dropped gergel from review 'cause she's crazy busy.

@brews
Copy link
Member Author

brews commented Dec 18, 2021

Merging this to meet a new deadline but please let me know here or in open issues if you have questions or suggestions on this @emileten. You input is valued.

@brews brews merged commit d865a00 into ClimateImpactLab:main Dec 18, 2021
@brews brews deleted the setup_change branch December 18, 2021 00:47
@emileten
Copy link
Contributor

@brews yea I recently came across these .toml and .cfg files to package python. I didn't know it's best practice. Do you have some source/reference that explains why ? (Just my curiosity, no issue).

@emileten
Copy link
Contributor

Got it I think ! The official :) https://packaging.python.org/en/latest/tutorials/packaging-projects/

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants