[ BB2-1180 ] Prep needed to Publish (#16)

* Update setup.py add requests-toolbelt

* Update setup.py for dev

* Add coverage RC config

* Update MANIFEST.in

* Update .gitignore with bb2_venv exclude

* Remove un-needed MANIFEST.in

* Update version and package naming

* Update README w/ publishing instruction

* Added some slight tweaks and updated version to test pypi upload

Co-authored-by: Adrian Jones <adrian.jones@adhocteam.us>

Author: dtisza1

.gitignore

@@ -153,6 +153,7 @@ cython_debug/
 
 # Virtual Env
 bb2_env/
+bb2_venv/
 
 # PyCharm
 #  JetBrains specific template is maintainted in a separate JetBrains.gitignore that can

MANIFEST.in

@@ -11,32 +11,32 @@ It is intended for BB2 team members or others performing SDK development work.
 - Install Python for your environment and verify the version with:
 
   ```
-  $ python --version
+  python --version
   # or
-  $ python3 --version
+  python3 --version
   ```
 
   This should output a 3.x version number.
 
-- Install up to date versions of pip, setuptools and wheel:
-  ```
-  $ python3 -m pip install --upgrade pip setuptools wheel
-  ```
-- Optionally you can use a virtual environment for the previous insall step via the following:
-  ```
-  $ python -m venv bb2_env
-  $ source bb2_env/bin/activate
-  # Perform install and commands after sourcing the venv.
-  ```
-## Installation
+- You should use a virtual environment.
 
-To install the package file do the following:
+  - To create a virtual environment and activate it, use the following commands:
 
-```
-# From repository root directory:
-$ pip install <package file name>
-```
+    ```
+    python3 -m venv bb2_venv
+    source bb2_venv/bin/activate
+    # Perform install and commands after sourcing the venv.
+    ```
 
+- Install current versions of pip, setuptools, wheel and twine.
+
+  ```
+  # Update PIP
+  pip install --upgrade pip
+
+  # Update tools
+  python3 -m pip install --upgrade pip setuptools wheel twine
+  ```
 
 ## Developing the Blue Button 2.0 SDK (for BB2 team SDK developers)
 
@@ -47,7 +47,7 @@ To install with the tools you need to develop and run tests do the following:
 From the repository base directory:
 
 ```
-$ pip install -e .[dev]
+pip install -e .[dev]
 ```
 
 ### Running tests
@@ -57,93 +57,246 @@ To run the tests, use the following commands:
 From the package base directory:
 
 ```
-$ cd cms_bluebutton
+cd cms_bluebutton
 
-$ # To run all tests:
-$ pytest
+# To run all tests:
+pytest
 
-$ # To run a specific test and show console debugging output:
-$ pytest tests/test_fhir_request.py -s
+# To run a specific test and show console debugging output:
+pytest tests/test_fhir_request.py -s
 ```
 
 To run the tests with coverage, use the following commands:
 
 From the package base directory:
 
 ```
-$ coverage run -m pytest
+coverage run -m pytest
 
 # Check report
-$ coverage report -m
+coverage report -m
 ```
 
 ## Packaging and Publishing
 
+### Build Package
 
-### Create or Update Manifest
+To build the cms_bluebutton package do the following:
 
-If check-manifest is not yet installed run the following:
+- Build a wheel distribution package (.whl):
 
-```
-$ pip install check-manifest  # If not already installed.
-```
+  ```
+  # From repository root directory:
+  rm -rf build/
+  python setup.py bdist_wheel
+  ```
 
-If MANIFEST.in does not yet exist, run the following to create it:
+The resulting distribution files with be created in the `dist/` directory.
 
-```
-$ check-manifest --create
-```
+- Review the files included with the following. Update the filename for the target version.
+
+  ```
+  unzip -l dist/cms_bluebutton_sdk-0.1.0-py3-none-any.whl 
+  ```
+
+
+### Install from a Package File
 
-To help with updating MANIFEST.in run the following to get information:
+The package file can be installed via the following command:
 
+```bash
+pip install dist/cms_bluebutton_sdk-0.1.0-py3-none-any.whl # wheel
 ```
-$ check-manifest
-# This creates the following directory: cms_bluebutton.egg-info
+
+
+### Un-install from a Package File
+
+The package can be un-installed via the following command:
+
+```bash
+pip uninstall cms_bluebutton_sdk
 ```
 
-### Build Packages
 
-To build the cms_bluebutton packages do the following:
+### Publish Testing using the TestPyPI registry instance
 
-- Build a wheel distribution package (.whl):
+Before publishing to the main PyPI registry, testing can be perfomed using the TestPyPI site.
+
+See the following for more details:  https://packaging.python.org/en/latest/guides/using-testpypi/
+
+#### Prerequisite tasks:
+
+- Create an OWNER type of account. This is the account that will own the `cms-bluebutton-sdk` project.
+
+- Perform the initial release upload of the project using this account. See upload instruction below.
+
+- BB2 developers who will be uploading releases need to create their own accounts.
+
+- The OWNER account can setup the developers as MAINTAINERS on the project.
+
+  - Maintainers will have the following role permissions for the project:
+
+    Has permissions to Upload releases for a package. Can upload releases. Cannot invite collaborators. Cannot delete files, releases, or the project.
+
+
+#### Upload project to TestPyPI
+
+- Setup your configuration by adding the following lines to your $HOME/.pypirc file:
 
   ```
-  # From repository root directory:
-  $ rm -rf build/
-  $ python setup.py bdist_wheel
+  [testpypi]
+  username = <your TestPyPI username>
   ```
 
-- Build a distribution package (.tar.gz):
+- Source the virtual environment from previous instruction.
 
+  ```bash
+    source bb2_venv/bin/activate
   ```
-  # From repository root directory:
-  $ rm -rf build/
-  $ python setup.py sdist
+
+- Upload to the TestPyPI registry with the following command:
+
+  ```bash
+  twine upload --repository testpypi dist/cms_bluebutton_sdk-0.1.0-py3-none-any.whl
   ```
 
-- Build a source package:
+  Enter the account password.
+
+- Confirm the project was uploaded via the following URL: https://test.pypi.org/project/cms-bluebutton-sdk
+
 
+#### Install test using TestPyPI
+
+- Setup a temporary virtual environment to test the install.
+
+  ```bash
+  python3 -m venv /tmp/test_bb2_venv
+  source /tmp/test_bb2_venv/bin/activate
+  # Perform install and commands after sourcing the venv.
   ```
-  # From repository root directory:
-  $ rm -rf build/
-  $ python setup.py sdist
+
+- Install `cms-bluebutton-sdk` from TestPyPI. Extras are installed from the main PyPI registry.
+
+  ```bash
+  pip install --index-url https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple/ cms-bluebutton-sdk
   ```
 
-The resulting distribution files with be created in the `dist/` directory.
+- Show the installed package.
 
-### Install from a Package File
+    ```bash
+    pip show cms-bluebutton-sdk
+    ```
 
-Package files can be installed via the following commands:
+- Test imports with the following.
 
-```bash
-pip install cms_bluebutton-0.1.0-py3-none-any.whl # wheel
-```
-or 
+  ```bash
+  cat <<EOF >test_bb2_sdk.py
+  from cms_bluebutton import BlueButton, AuthorizationToken
+  EOF
+  python test_bb2_sdk.py 
+  ```
 
-```bash
-pip install cms_bluebutton-0.1.0.tar.gz # bdist
-```
+  - If successful, there will be no errors in the output.
+
+
+### Publish to the main PyPI registry
+
+After testing, the package / release can be published to the main PyPI site.
+
+See the following for more details:  https://pypi.org/
+
+#### Prerequisite tasks:
+
+- Create an OWNER type of account. This is the account that will own the `cms-bluebutton-sdk` project.
+
+- Perform the initial release upload of the project using this account. See upload instruction below.
+
+- BB2 developers who will be uploading releases need to create their own accounts.
+
+- The OWNER account can setup the developers as MAINTAINERS on the project.
+
+  - Maintainers will have the following role permissions for the project:
+
+    Has permissions to Upload releases for a package. Can upload releases. Cannot invite collaborators. Cannot delete files, releases, or the project.
+
+
+#### Upload project to PyPI
+
+- Setup your configuration by adding the following lines to your $HOME/.pypirc file:
+
+  ```
+  [pypi]
+  username = <your PyPI username>
+  ```
+
+- Source the virtual environment from previous instruction.
+
+  ```bash
+    source bb2_venv/bin/activate
+  ```
+
+- Upload to the PyPI registry with the following command. Update the filename for the target version.
+
+  ```bash
+  twine upload dist/cms_bluebutton_sdk-0.1.0-py3-none-any.whl
+  ```
+
+  Enter the account password.
+
+- Confirm the project was uploaded at the following URL: https://pypi.org/project/cms-bluebutton-sdk
+
+
+#### Install test using PyPI
+
+- Setup a temporary virtual environment to test the install.
+
+  ```bash
+  python3 -m venv /tmp/test_bb2_venv
+  source /tmp/test_bb2_venv/bin/activate
+  # Perform install and commands after sourcing the venv.
+  ```
+
+- Install `cms-bluebutton-sdk` from TestPyPI. Extras are installed from the main PyPI registry.
+
+  ```bash
+  pip install cms-bluebutton-sdk
+  ```
+
+- Show the installed package.
+
+    ```bash
+    pip show cms-bluebutton-sdk
+    ```
 
-### Publishing
+- Test imports with the following.
+
+  ```bash
+  cat <<EOF
+  from cms_bluebutton import BlueButton, AuthorizationToken
+  print("IMPORT TEST SUCCESSFUL!!!")
+  EOF
+  python test_bb2_sdk.py 
+  ```
+
+  - If successful, there will be no errors and the following message will output:
+
+       IMPORT TEST SUCCESSFUL!!!
+
+- Remove the test virtual environmnet to clean up.
+
+  ```bash
+  rm -rf /tmp/test_bb2_venv/
+  ```
+
+### Publishing NEW versions
+
+New versions can be published using the previous build, TestPyPI and PyPI publishing instruction.
+
+Before building and publishing a new version, the version number needs to be increased.
+
+To do this, edit the following line in the `setup.py` file with the desired release version:
+
+```
+    version="0.1.0",
+```
 
-TODO!

README-sdk-dev.md

@@ -0,0 +1,4 @@
+# .coveragerc to control coverage.py
+[run]
+source=.
+omit=./tests/*