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

Pull in most template updates #128

Merged
merged 31 commits into from Apr 19, 2023
Merged

Conversation

pacrob
Copy link
Contributor

@pacrob pacrob commented Apr 14, 2023

What was wrong?

The python project template was recently update. This pulls in many of those changes, leaving mypy, flake8, and isort updates for separate prs.

To-Do

  • Clean up commit history

Cute Animal Picture

image

carver and others added 25 commits August 31, 2022 14:33
It can get big with installed libraries. On a relatively small release
of eth-portal, this one change cut the .tar.gz release size from 574Kb
to 14Kb.
* Tweaks to release process

* Drop python 3.6
toxinidir won't mean anything in a Makefile
- Clean up github PR template to remove double links to the newsfragment README.md
- Clean up some typos and make some minor refactors.
- It is not recommended to invoke ``setup.py`` directly, instead opting for ``python -m build`` for the commands in this commit (see: https://blog.ganssle.io/articles/2021/10/setup-py-deprecated.html)
- Add newsfragment for ethereum#70
Do not invoke `setup.py` directly; minor refactor + cleanup
bump docs dependencies, add readthedocs requirements
* convert bash scripts to py
* bump versions in dependencies and ci builds

* move tox to [dev] per issue ethereum#34

* move RTD deps pointer into .readthedocs.yml

* unpin flake8 add flake8-bugbear to lint deps
* remove gitter, testing setup, and pandoc sections, add quotes to dev install
* repin flake8, bump tox to >=4.0.0 as that's where whitelist was deprecated, misc updates
* template cleanup following initial merge with py-evm

* add flake8 pin comment

* correct license years

* add pin note to mypy
…m#81)

* apply template updates found following merge with eth-typing

* add build as a dev dependency

* remove timeout from pytest.ini, it doesn't do anything without pytest-timeout as a dep
@pacrob pacrob changed the title [WIP] Pull in template, adding flake8 and isort [WIP] Pull in less-sensitive template updates Apr 14, 2023
@pacrob pacrob force-pushed the upgrade-template branch 3 times, most recently from 4e8955b to fac7b91 Compare April 14, 2023 17:10
@pacrob pacrob force-pushed the upgrade-template branch 2 times, most recently from 406bda8 to b23b107 Compare April 14, 2023 17:22
@pacrob pacrob changed the title [WIP] Pull in less-sensitive template updates Pull in most template updates Apr 14, 2023
@pacrob pacrob force-pushed the upgrade-template branch 10 times, most recently from 26212c6 to 2cd467b Compare April 18, 2023 18:31
@pacrob pacrob requested review from kclowes and fselmo April 19, 2023 16:15
Copy link
Collaborator

@kclowes kclowes left a comment

Choose a reason for hiding this comment

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

Thank you!

I'm getting a new doc warning that should probably get cleaned up on make docs: WARNING: html_static_path entry '_static' does not exist. Looks good otherwise!

Copy link
Collaborator

@kclowes kclowes Apr 19, 2023

Choose a reason for hiding this comment

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

Did this come from the template? I wonder if it works/we should keep it?

Edit: I'm okay removing it for consistency's sake, but it's something that would be nice to add to our repos eventually. Then we don't have to fight with the linter all the time.

'.removal.rst',
".breaking.rst",
".bugfix.rst",
".deprecation",
Copy link
Collaborator

Choose a reason for hiding this comment

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

I think this should be .deprecation.rst?

pyproject.toml Outdated
Copy link
Collaborator

Choose a reason for hiding this comment

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

I believe we'll need to add a new [[tool.towncrier.type]] for deprecation as well in order for it to show up on the release notes

setup.py Outdated
@@ -67,7 +65,7 @@
"pyrsistent>=0.16.0,<0.17",
],
setup_requires=[],
python_requires=">=3.7, <4",
Copy link
Collaborator

Choose a reason for hiding this comment

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

nit: I'm not sure that >=3.7.2 should be in the template. I know >=3.7.2 holds for web3.py but I'm not 100% why. I think it's probably better to err wide (as in change this back to 3.7) since pip actually validates this on install 🤷‍♀️

@pacrob pacrob force-pushed the upgrade-template branch 3 times, most recently from 3a1d41b to 6ab2589 Compare April 19, 2023 19:51
@pacrob pacrob merged commit 974f33e into ethereum:master Apr 19, 2023
21 checks passed
@pacrob pacrob deleted the upgrade-template branch April 19, 2023 19:55
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

4 participants