Skip to content

Commit 2300626

Browse files
committed
lint: clean repo
1 parent 0965453 commit 2300626

File tree

7 files changed

+27
-68
lines changed

7 files changed

+27
-68
lines changed

.pylintrc

-11
This file was deleted.

.python-version

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
3.8

.vscode/settings.json

-11
This file was deleted.

Makefile

-26
This file was deleted.

README.md

+7-17
Original file line numberDiff line numberDiff line change
@@ -4,22 +4,12 @@
44

55
## Install
66

7-
**RENAME NOTICE (2022-08-05):** This package will be renamed to `epidatpy`.
8-
Please adjust all references to the package name accordingly.
9-
For a short-term fix, the package can be used with the old name by installing with `ref="delphi_epidata-before-rename"`.
10-
117
Install latest version:
128

139
```sh
1410
pip install -e "git+https://github.com/cmu-delphi/epidatpy.git#egg=epidatpy"
1511
```
1612

17-
old name version
18-
19-
```sh
20-
pip install -e "git+https://github.com/cmu-delphi/epidatpy.git@delphi_epidata-before-rename#egg=delphi_epidata"
21-
```
22-
2313
## Usage
2414

2515
TODO
@@ -53,13 +43,13 @@ inv release # upload the current version to pypi
5343
The release consists of multiple steps which can be all done via the GitHub website:
5444

5545
1. Go to [create_release GitHub Action](https://github.com/cmu-delphi/epidatpy/actions/workflows/create_release.yml) and click the `Run workflow` button. Enter the next version number or one of the magic keywords (patch, minor, major) and hit the green `Run workflow` button.
56-
1. The action will prepare a new release and will end up with a new [Pull Request](https://github.com/cmu-delphi/epidatpy/pulls)
57-
1. Let the code owner review the PR and its changes and let the CI check whether everything builds successfully
58-
1. Once approved and merged, another GitHub action job starts which automatically will
59-
1. create a git tag
60-
1. create another [Pull Request](https://github.com/cmu-delphi/epidatpy/pulls) to merge the changes back to the `dev` branch
61-
1. create a [GitHub release](https://github.com/cmu-delphi/epidatpy/releases) with automatically derived release notes
62-
1. Done
46+
2. The action will prepare a new release and will end up with a new [Pull Request](https://github.com/cmu-delphi/epidatpy/pulls)
47+
3. Let the code owner review the PR and its changes and let the CI check whether everything builds successfully
48+
4. Once approved and merged, another GitHub action job starts which automatically will
49+
1. create a git tag
50+
2. create another [Pull Request](https://github.com/cmu-delphi/epidatpy/pulls) to merge the changes back to the `dev` branch
51+
3. create a [GitHub release](https://github.com/cmu-delphi/epidatpy/releases) with automatically derived release notes
52+
5. Done
6353

6454
[mit-image]: https://img.shields.io/badge/License-MIT-yellow.svg
6555
[mit-url]: https://opensource.org/licenses/MIT

epidatpy/__init__.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
"""Fetch data from Delphi's API.
2-
"""
1+
"""Fetch data from Delphi's API."""
2+
33
from ._constants import __version__
44
from ._model import (
55
EpiRange,

pyproject.toml

+17-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,21 @@
1-
21
[tool.black]
32
line-length = 120
43
target-version = ['py38']
54
include = 'epidatpy'
5+
6+
[tool.pylint]
7+
max-line-length = 120
8+
min-public-methods = 1
9+
disable = [
10+
"R0801",
11+
"E1101",
12+
"E0611",
13+
"C0114",
14+
"C0116",
15+
"C0103",
16+
"R0913",
17+
"R0914",
18+
"W0702",
19+
"too-many-public-methods",
20+
"too-many-instance-attributes",
21+
]

0 commit comments

Comments
 (0)