Skip to content

Setup: Init - Initial setup.py and basic configs - #4

Merged
Yifan Xiong (abuccts) merged 10 commits into
devfrom
xiongyf/setup-py
Jan 28, 2021
Merged

Setup: Init - Initial setup.py and basic configs#4
Yifan Xiong (abuccts) merged 10 commits into
devfrom
xiongyf/setup-py

Conversation

@abuccts

@abucctsYifan Xiong (abuccts) commented Jan 27, 2021•
edited
Loading

Copy link
Copy Markdown
Member

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

@abuccts
Setup: Init - Initial setup.py and basic configs
ea9ef52
* inital setup.py
* add gitignore and dockerignore
* add editorconfig
* add yapf, mypy, flake8 for type check and lint
cp5555
Peng Cheng (cp5555) reviewed Jan 27, 2021
View reviewed changes
Comment thread.style.yapf Outdated
cp5555
Peng Cheng (cp5555) reviewed Jan 27, 2021
View reviewed changes
Comment thread.flake8 Outdated
@abuccts
Update max-line-length in lint
99ed3f1
Update max-line-length in lint, use default 79.
cp5555
Peng Cheng (cp5555) reviewed Jan 27, 2021
View reviewed changes
Comment threadsetup.cfg Outdated
cp5555
Peng Cheng (cp5555) reviewed Jan 27, 2021
View reviewed changes
Comment threadsetup.py
cp5555
Peng Cheng (cp5555) reviewed Jan 27, 2021
View reviewed changes
Comment threadsetup.py Outdated
"Programming Language :: Python :: 3.7",
"Programming Language :: Python :: 3.8",
"Programming Language :: Python :: 3.9",
"Topic :: System :: Benchmark",

@cp5555Peng Cheng (cp5555)Jan 27, 2021

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

TobeyQin would you please check it?

cp5555
Peng Cheng (cp5555) approved these changes Jan 27, 2021
View reviewed changes

@cp5555Peng Cheng (cp5555) left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Would you please double check with TobeyQin about the category?

@abuccts

Yifan Xiong (abuccts) commented Jan 27, 2021

Copy link
Copy Markdown
MemberAuthor

Would you please double check with TobeyQin about the category?

TobeyQin pls refer to classifiers list

@abuccts
Update according to comments
64b8dd7
Update according to comments.
guoshzhao
guoshzhao approved these changes Jan 27, 2021
View reviewed changes
Comment threadtest.dockerfile Outdated
Comment thread.gitignore
@abuccts
Add lint rules for quotes, docstring, type hint
e81eb62
* 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/`
@abuccts
Add spelling check for typo
4e0c1bf
Add spelling check for typo.
@abuccts
Fix warning and typo
1e078c6
Fix warning and typo.
@abuccts
Add pre-commit config
c16235f
Add pre-commit config.
cp5555
Peng Cheng (cp5555) reviewed Jan 27, 2021
View reviewed changes
Comment threadsuperbench/__init__.py Outdated
cp5555
Peng Cheng (cp5555) reviewed Jan 27, 2021
View reviewed changes
Comment threadsetup.py Outdated
cp5555
Peng Cheng (cp5555) reviewed Jan 27, 2021
View reviewed changes
Comment threadsetup.py
cp5555
Peng Cheng (cp5555) reviewed Jan 27, 2021
View reviewed changes
Comment thread.pre-commit-config.yaml
cp5555
Peng Cheng (cp5555) reviewed Jan 27, 2021
View reviewed changes
Comment thread.flake8 Outdated
cp5555
Peng Cheng (cp5555) reviewed Jan 27, 2021
View reviewed changes
Comment thread.mypy.ini
@abuccts
Yifan Xiong (abuccts) requested a review from a team as a code ownerJanuary 28, 2021 02:29
@abuccts
Add docstrings and remove exception rules
3b9f9e7
Add docstrings and remove exception rules.
@abuccts
Yifan Xiong (abuccts) deleted the xiongyf/setup-py branch January 28, 2021 13:01
@cp5555Peng Cheng (cp5555) added test Unit tests, lint or format check related CI/CD Continuous integration or deployment labels Feb 5, 2021
Yifan Xiong (abuccts) added a commit that referenced this pull request Apr 13, 2021
@abuccts
Setup: Init - Initialize setup.py and basic configs (#4)
4a070f7
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
Yifan Xiong (abuccts) added a commit that referenced this pull request Apr 13, 2021
@abuccts
Revert "Setup: Init - Initialize setup.py and basic configs (#4)"
7b20f69
This reverts commit 4a070f7.
@polarGHongtao Zhang (polarG) mentioned this pull request May 22, 2026
Open
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@cp5555Peng Cheng (cp5555)cp5555 approved these changes
@guoshzhaoguoshzhaoguoshzhao approved these changes
@TobeyQinTobeyQinAwaiting requested review from TobeyQin

Assignees

No one assigned

Labels

CI/CDContinuous integration or deploymenttestUnit tests, lint or format check related

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@abuccts@cp5555@guoshzhao