Skip to content

Commit 4ec482c

Browse files
authored
Add IDE bindings for epidata development (#1004)
1 parent bef5839 commit 4ec482c

File tree

4 files changed

+94
-1
lines changed

4 files changed

+94
-1
lines changed

README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,8 @@ You should now have the following directory structure:
2626
│ ├── .dockerignore -> repos/delphi/delphi-epidata/dev/local/.dockerignore
2727
│ ├── Makefile -> repos/delphi/delphi-epidata/dev/local/Makefile
2828
│ ├── repos
29+
│ │ ├── pyproject.toml -> delphi/delphi-epidata/dev/local/pyproject.toml
30+
│ │ ├── setup.cfg -> delphi/delphi-epidata/dev/local/setup.cfg
2931
│ │ └── delphi
3032
│ │ ├── delphi-epidata
3133
│ │ ├── flu-contest
@@ -52,6 +54,16 @@ $ [sudo] make test pdb=1
5254
$ [sudo] make test test=repos/delphi/delphi-epidata/integrations/acquisition
5355
```
5456

57+
Enabling features like code autocompletion and linting in your editor
58+
requires one extra step (prerequisites: up-to-date pip and setuptools v64+):
59+
60+
```sh
61+
$ cd repos
62+
63+
# Installs the working directory as an "editable package"
64+
$ pip install -e . --config-settings editable_mode=strict
65+
```
66+
5567
# COVIDcast
5668

5769
At the present, our primary focus is developing and expanding the

dev/local/install.sh

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,17 @@
22
# Bootstrap delphi-epidata development
33
#
44
# Downloads the repos needed for local delphi-epidata development into current dir
5-
# and provides a Makefile with Docker control commands.
5+
# and provides a Makefile with Docker control commands
6+
# as well as pyproject/setup.cfg files for IDE mappings.
67
#
78
# Creates the directory structure:
89
#
910
# driver/
1011
# .dockerignore
1112
# Makefile
1213
# repos/
14+
# pyproject.toml
15+
# setup.cfg
1316
# delphi/
1417
# operations/
1518
# delphi-epidata/
@@ -43,3 +46,7 @@ cd ../../
4346

4447
ln -s repos/delphi/delphi-epidata/dev/local/Makefile
4548
ln -s repos/delphi/delphi-epidata/dev/local/.dockerignore
49+
cd repos
50+
ln -s delphi/delphi-epidata/dev/local/pyproject.toml
51+
ln -s delphi/delphi-epidata/dev/local/setup.cfg
52+
cd -

dev/local/pyproject.toml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
[build-system]
2+
requires = ["setuptools>=65", "wheel"]
3+
build-backend = "setuptools.build_meta"

dev/local/setup.cfg

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
[metadata]
2+
name = Delphi Development
3+
version = 0.4.0
4+
5+
[options]
6+
packages =
7+
delphi.epidata
8+
delphi.epidata.acquisition
9+
delphi.epidata.acquisition.afhsb
10+
delphi.epidata.acquisition.cdcp
11+
delphi.epidata.acquisition.covid_hosp
12+
delphi.epidata.acquisition.covid_hosp.common
13+
delphi.epidata.acquisition.covid_hosp.facility
14+
delphi.epidata.acquisition.covid_hosp.state_daily
15+
delphi.epidata.acquisition.covid_hosp.state_timeseries
16+
delphi.epidata.acquisition.covidcast
17+
delphi.epidata.acquisition.covidcast_nowcast
18+
delphi.epidata.acquisition.ecdc
19+
delphi.epidata.acquisition.flusurv
20+
delphi.epidata.acquisition.fluview
21+
delphi.epidata.acquisition.ght
22+
delphi.epidata.acquisition.kcdc
23+
delphi.epidata.acquisition.nidss
24+
delphi.epidata.acquisition.norostat
25+
delphi.epidata.acquisition.paho
26+
delphi.epidata.acquisition.quidel
27+
delphi.epidata.acquisition.twtr
28+
delphi.epidata.acquisition.wiki
29+
delphi.epidata.client
30+
delphi.epidata.server
31+
delphi.epidata.server.covidcast_issues_migration
32+
delphi.epidata.server.endpoints
33+
delphi.epidata.server.endpoints.covidcast_utils
34+
delphi.epidata.server.utils
35+
delphi.flu_contest
36+
delphi.flu_contest
37+
delphi.flu_contest.archefilter
38+
delphi.flu_contest.covid
39+
delphi.flu_contest.epicast
40+
delphi.flu_contest.forecasters
41+
delphi.flu_contest.hosp
42+
delphi.flu_contest.main
43+
delphi.flu_contest.uploads
44+
delphi.flu_contest.utils
45+
delphi.github_deploy_repo
46+
delphi.github_deploy_repo.actions
47+
delphi.nowcast
48+
delphi.nowcast.experiments
49+
delphi.nowcast.fusion
50+
delphi.nowcast.obsolete
51+
delphi.nowcast.sensors
52+
delphi.nowcast.util
53+
delphi.operations
54+
delphi.operations.database_metrics
55+
delphi.operations.screenshots
56+
delphi.operations.screenshots.covidcast
57+
delphi.utils
58+
delphi.utils.geo
59+
delphi.utils.obsolete
60+
undefx.py3tester
61+
undefx.undef_analysis
62+
63+
package_dir =
64+
delphi.epidata = delphi/delphi-epidata/src
65+
delphi.flu_contest = delphi/flu-contest/src
66+
delphi.github_deploy_repo = delphi/github-deploy-repo/src
67+
delphi.nowcast = delphi/nowcast/src
68+
delphi.operations = delphi/operations/src
69+
delphi.utils = delphi/utils/src
70+
undefx.py3tester = undefx/py3tester/src
71+
undefx.undef_analysis = undefx/undef-analysis

0 commit comments

Comments
 (0)