Skip to content

Commit 0cfbe99

Browse files
committed
package python client for PyPI
This is one step toward resolving #2. The package can be installed with pip like: `pip install delphi-epidata` Note: the file `delphi_epidata.py` is missing from the package dir. This is simply to avoid (1) duplicating code within the repo while (2) not messing up the code structure since other projects expect to find `delphi_epidata.py` in a particular location. To build a new release of the package, first copy `delphi_epidata.py` into the package, then follow the instructions at https://packaging.python.org/tutorials/packaging-projects/
1 parent ea9fea3 commit 0cfbe99

File tree

5 files changed

+59
-2
lines changed

5 files changed

+59
-2
lines changed

LICENSE

+1-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
The MIT License (MIT)
22

3-
Copyright (c) 2016 The Delphi Group at Carnegie Mellon University
3+
Copyright (c) 2018 The Delphi Group at Carnegie Mellon University
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy
66
of this software and associated documentation files (the "Software"), to deal
@@ -19,4 +19,3 @@ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
1919
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
2020
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
2121
SOFTWARE.
22-

src/client/packaging/pypi/LICENSE

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
The MIT License (MIT)
2+
3+
Copyright (c) 2018 The Delphi Group at Carnegie Mellon University
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

src/client/packaging/pypi/README.md

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# Delphi Epidata API Client
2+
3+
This package provides a programmatic interface to
4+
[Delphi](https://delphi.midas.cs.cmu.edu/)'s epidemiological data ("epidata")
5+
API. Source code and usage information can be found at
6+
[https://github.com/cmu-delphi/delphi-epidata](https://github.com/cmu-delphi/delphi-epidata).
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
from .delphi_epidata import Epidata
2+
3+
name = 'delphi_epidata'
4+
__version__ = '0.0.4'

src/client/packaging/pypi/setup.py

+27
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
import setuptools
2+
3+
with open('README.md', 'r') as f:
4+
long_description = f.read()
5+
6+
setuptools.setup(
7+
name='delphi_epidata',
8+
version='0.0.4',
9+
author='David Farrow',
10+
author_email='[email protected]',
11+
description='A programmatic interface to Delphi\'s Epidata API.',
12+
long_description=long_description,
13+
long_description_content_type='text/markdown',
14+
url='https://github.com/cmu-delphi/delphi-epidata',
15+
packages=setuptools.find_packages(),
16+
install_requires=[
17+
'requests>=2.7.0',
18+
],
19+
classifiers=[
20+
'Programming Language :: Python',
21+
'License :: OSI Approved :: MIT License',
22+
'Operating System :: OS Independent',
23+
'Intended Audience :: Science/Research',
24+
'Natural Language :: English',
25+
'Topic :: Scientific/Engineering :: Bio-Informatics',
26+
],
27+
)

0 commit comments

Comments
 (0)