Setup: Init - Initial setup.py and basic configs#4
Merged
Conversation
* inital setup.py * add gitignore and dockerignore * add editorconfig * add yapf, mypy, flake8 for type check and lint
cp5555
reviewed
Jan 27, 2021
cp5555
reviewed
Jan 27, 2021
Update max-line-length in lint, use default 79.
cp5555
reviewed
Jan 27, 2021
cp5555
reviewed
Jan 27, 2021
cp5555
reviewed
Jan 27, 2021
Member
Author
@TobeyQin pls refer to classifiers list |
Update according to comments.
guoshzhao
approved these changes
Jan 27, 2021
* follow [pep257](https://www.python.org/dev/peps/pep-0257/), use single quote for inline quotes and double quote for multiline/docstring * require docstring in `superbench/` * require typed defs in `superbench/`
Add spelling check for typo.
Fix warning and typo.
Add pre-commit config.
cp5555
reviewed
Jan 27, 2021
cp5555
reviewed
Jan 27, 2021
cp5555
reviewed
Jan 27, 2021
cp5555
reviewed
Jan 27, 2021
cp5555
reviewed
Jan 27, 2021
cp5555
reviewed
Jan 27, 2021
Update description according to comments.
Add docstrings and remove exception rules.
cp5555
approved these changes
Jan 28, 2021
cp5555
added
test
abuccts
added a commit
that referenced
this pull request
Apr 13, 2021
Initialize setup.py and basic configurations for this project.
Major revisions:
- initialize setup.py for Python package
- add gitignore and dockerignore
- add editorconfig for editors
- configure yapf for auto formating
- configure mypy for type hint
- configure flake8 for lint, including quotes and docstrings
- add pre-commit check for `git commit`
- add spelling check in GitHub Actions
- format existing files according to configured rules
Example usage:
# install dependencies
$ python3 -m pip install -e .[dev,test]
$ pre-commit install
# format code automatically
$ python3 setup.py format
# lint code
$ python3 setup.py lint
# test code
$ python3 setup.py test
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Initialize setup.py and basic configurations for this project.
Major revisions:
git commitExample usage: