Skip to content

Commit abdfee4

Browse files
committed
Update setup.py and README.md
- Add more setup fields to setup.py - Add classifiers to setup.py - Add initial required and extra "dev" packages to setup.py - Update README.md with SDK dev info - Add init file BB2-1075
1 parent 191fabc commit abdfee4

3 files changed

Lines changed: 38 additions & 1 deletion

File tree

README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,4 +59,12 @@ Type "help", "copyright", "credits" or "license" for more information.
5959
>>> a.hello()
6060
Hello from BB2 SDK Class method!!!
6161
>>>
62+
```
63+
64+
## Developing the Blue Button 2.0 SDK (for BB2 devs)
65+
66+
To install with the tools you need to develop and run tests do the following:
67+
68+
```
69+
pip install -e .[dev]
6270
```

setup.py

Lines changed: 30 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,39 @@
11
from setuptools import setup
22

33

4+
with open("README.md", "r", encoding="utf-8") as fh:
5+
long_description = fh.read()
6+
47
setup(
58
name="cms-bb2",
69
version="0.0.1",
10+
author="CMS Blue Button 2.0 Team",
11+
author_email="bb2@example.com", # TODO: Do we want to include?
12+
license="Apache Software License",
713
description="An SDK used for interacting with the CMS Blue Button 2.0 API",
14+
long_description=long_description,
15+
long_description_content_type="text/markdown",
16+
url="https://github.com/CMSgov/cms-bb2-python-sdk",
17+
# For classifiers: https://pypi.org/classifiers/
18+
classifiers=[
19+
"Programming Language :: Python :: 3",
20+
"License :: OSI Approved :: Apache Software License",
21+
"Operating System :: OS Independent",
22+
"Development Status :: 3 - Alpha",
23+
"Intended Audience :: Developers",
24+
"Intended Audience :: Healthcare Industry",
25+
"Topic :: Software Development",
26+
"Topic :: Software Development :: Libraries :: Python Modules",
27+
],
828
py_modules=["bb2"],
929
package_dir={"": "src"},
10-
)
30+
python_requires=">=3.6",
31+
install_requires=[
32+
"requests >= 2.0",
33+
],
34+
extras_require={
35+
"dev": [
36+
"pytest >= 3.0",
37+
],
38+
},
39+
)

src/__init__.py

Whitespace-only changes.

0 commit comments

Comments
 (0)