Skip to content

Commit 85ff42e

Browse files
committed
Add MANIFEST.in and instruction
1 parent 894dd6c commit 85ff42e

2 files changed

Lines changed: 25 additions & 1 deletion

File tree

MANIFEST.in

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
recursive-include src *.py

README.md

Lines changed: 24 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,8 @@ Hello from BB2 SDK Class method!!!
6363

6464
## Developing the Blue Button 2.0 SDK (for BB2 devs)
6565

66+
### Install Development
67+
6668
To install with the tools you need to develop and run tests do the following:
6769

6870
```
@@ -74,4 +76,25 @@ To run the tests run the following commands:
7476
```
7577
# From the src/ directory
7678
$ pytest
77-
```
79+
```
80+
### Create Distribution
81+
82+
To create a distribution run the following command:
83+
84+
```
85+
$ python setup.py sdist
86+
```
87+
88+
The resulting distribution files with be created in the `sdist/` directory.
89+
90+
### Create Manifest
91+
92+
Note that the previous distribution did not include the license.txt or test files. This requires creating a manifest.
93+
94+
To create a MANIFEST.in file run the following commands:
95+
96+
```
97+
$ pip install check-manifest # If not already installed.
98+
$ check-manifest --create
99+
$ python setup.py sdist
100+
```

0 commit comments

Comments
 (0)