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
Upgrade template #228
Upgrade template #228
Conversation
Update template
See an example issue here: ethereum#150
Show full explanation for pydocstyle failures
* Add breaking change type to newsfragment * Move breaking-change -> breaking
Frankly not sure why recursive-exclude doesn't work here, but prune does, and that's good enough for me now. It's also probably preferable to only exclude venv* at the root, anyway.
Use updated CircleCI images
Exclude huge and unnecessary venv*/ from dist
Upgrade towncrier to fix the duplicate title bug
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.
Don't push .tox file to tar.gz release
* Tweaks to release process * Drop python 3.6
toxinidir won't mean anything in a Makefile
Upgrade isort
- 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 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
* add updates found when merging template with py-ssz and eth-abi * add wheel and wheel-windows to ci and reorg
b0b3530
to
5135385
Compare
cad0622
to
50673ca
Compare
50673ca
to
edfb466
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good to me! Just had a few random comments.
pip install -e ".[dev]" | ||
``` | ||
|
||
To run the integration test cases, you need to install node and the custom cli tool as follows: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'd like to keep this integration testing documentation around somewhere. eth-account does fuzz testing against ethers for hdaccounts and I reference this periodically.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yup, that's my oversight. Added back.
@@ -86,6 +86,7 @@ def signTransaction(self, transaction_dict): | |||
warnings.warn( | |||
"signTransaction is deprecated in favor of sign_transaction", | |||
category=DeprecationWarning, | |||
stacklevel=2, |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm curious about this change - is it a flake8-bugbear
catch?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It is flake8-bugbear
. The full error was:
B028 No explicit stacklevel keyword argument found.
The warn method from the warnings module uses a stacklevel of 1 by default.
This will only show a stack trace for the line on which the warn method is called.
It is therefore recommended to use a stacklevel of 2 or greater to provide more information to the user.
It sounded reasonable to me so just added the stacklevel
arg.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yep, makes sense to me! Thanks!
], | ||
python_requires=">=3.6, <4", | ||
python_requires=">=3.7, <4", |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is a breaking change. I'm okay with including it, but let's make sure that we highlight in the release notes.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
added a breaking newsfragment
…fragment for drop py36 from setup.py
What was wrong?
The project template has been updated, this pulls in those changes.
To-Do
Cute Animal Picture