Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #52 from jacebrowning/drop-python-2
Drop support for Python 2
- Loading branch information
Showing
33 changed files
with
573 additions
and
652 deletions.
There are no files selected for viewing
This file contains 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
This file contains 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
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -3,6 +3,7 @@ | |
*.egg-info | ||
__pycache__ | ||
.ipynb_checkpoints | ||
setup.py | ||
|
||
# Temporary OS files | ||
Icon* | ||
|
This file contains 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
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
[mypy] | ||
|
||
ignore_missing_imports = true | ||
no_implicit_optional = true | ||
check_untyped_defs = true | ||
|
||
cache_dir = .cache/mypy/ |
This file contains 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
This file was deleted.
Oops, something went wrong.
This file contains 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
This file contains 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
This file contains 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
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,79 +1,76 @@ | ||
# For Contributors | ||
# Setup | ||
|
||
## Setup | ||
|
||
### Requirements | ||
## Requirements | ||
|
||
* Make: | ||
* Windows: http://mingw.org/download/installer | ||
* Mac: http://developer.apple.com/xcode | ||
* Linux: http://www.gnu.org/software/make | ||
* Poetry: https://poetry.eustace.io | ||
* Graphviz: http://www.graphviz.org/Download.php | ||
* macOS: `$ xcode-select --install` | ||
* Linux: [https://www.gnu.org/software/make](https://www.gnu.org/software/make) | ||
* Windows: [https://mingw.org/download/installer](https://mingw.org/download/installer) | ||
* Python: `$ pyenv install` | ||
* Poetry: [https://poetry.eustace.io/docs/#installation](https://poetry.eustace.io/docs/#installation) | ||
* Graphviz: | ||
* macOS: `$ brew install graphviz` | ||
* Linux: [https://graphviz.org/download](https://graphviz.org/download/) | ||
* Windows: [https://graphviz.org/download](https://graphviz.org/download/) | ||
|
||
To confirm these system dependencies are configured correctly: | ||
|
||
```sh | ||
```text | ||
$ make doctor | ||
``` | ||
|
||
### Installation | ||
## Installation | ||
|
||
Install project dependencies into a virtual environment: | ||
|
||
```sh | ||
```text | ||
$ make install | ||
``` | ||
|
||
## Development Tasks | ||
# Development Tasks | ||
|
||
### Testing | ||
## Manual | ||
|
||
Manually run the tests: | ||
Run the tests: | ||
|
||
```sh | ||
```text | ||
$ make test | ||
``` | ||
|
||
or keep them running on change: | ||
Run static analysis: | ||
|
||
```sh | ||
$ make watch | ||
```text | ||
$ make check | ||
``` | ||
|
||
> In order to have OS X notifications, `brew install terminal-notifier`. | ||
### Documentation | ||
|
||
Build the documentation: | ||
|
||
```sh | ||
```text | ||
$ make docs | ||
``` | ||
|
||
### Static Analysis | ||
## Automatic | ||
|
||
Run linters and static analyzers: | ||
Keep all of the above tasks running on change: | ||
|
||
```sh | ||
$ make pylint | ||
$ make pycodestyle | ||
$ make pydocstyle | ||
$ make check # includes all checks | ||
```text | ||
$ make watch | ||
``` | ||
|
||
## Continuous Integration | ||
> In order to have OS X notifications, `brew install terminal-notifier`. | ||
# Continuous Integration | ||
|
||
The CI server will report overall build status: | ||
|
||
```sh | ||
```text | ||
$ make ci | ||
``` | ||
|
||
## Release Tasks | ||
# Release Tasks | ||
|
||
Release to PyPI: | ||
|
||
```sh | ||
```text | ||
$ make upload | ||
``` |
Oops, something went wrong.