Merge pull request #1 from MSeal/master

Moves the Execute Preprocessor into a new library!!!

Author: MSeal

.bumpversion.cfg

@@ -0,0 +1,8 @@
+[bumpversion]
+current_version = 0.0.0
+commit = True
+tag = True
+tag_name = {new_version}
+
+[bumpversion:file:nbclient/_version.py]
+

.travis.yml

@@ -0,0 +1,31 @@
+language: python
+sudo: false
+matrix:
+  include:
+    - python: 3.5
+      env: TOXENV=py35
+    - python: 3.6
+      env: TOXENV=py36
+    - python: 3.7
+      env: TOXENV=py37
+    - python: 3.8
+      env: TOXENV=py38
+    - python: 3.6
+      env: TOXENV=flake8
+    - python: 3.6
+      env: TOXENV=dist
+    - python: 3.6
+      env: TOXENV=docs
+    - python: 3.6
+      env: TOXENV=manifest
+install:
+  - pip install tox
+script:
+  - tox -e $TOXENV
+after_success:
+  - test $TRAVIS_BRANCH = "master" &&
+    test $TOXENV = "py36" &&
+    coverage xml -i
+  - test $TRAVIS_BRANCH = "master" &&
+    test $TOXENV = "py36" &&
+    codecov

CHANGELOG.md

@@ -0,0 +1,4 @@
+# Change Log
+
+## 0.1.0
+- Initial release -- moved out of nbconvert 6.0.0-a0

CONTRIBUTING.md

@@ -0,0 +1,24 @@
+# Contributing
+
+We follow the
+[Jupyter Contribution Workflow](https://jupyter.readthedocs.io/en/latest/contributor/content-contributor.html)
+and the [IPython Contributing Guide](https://github.com/ipython/ipython/blob/master/CONTRIBUTING.md).
+
+# Testing
+
+In your environment `pip install -e '.[test]'` will be needed to be able to
+run all of the tests.
+
+# Documentation
+
+NbClient needs some PRs to copy over documentation!
+
+# Releasing
+
+If you are going to release a version of `nbclient` you should also be capable
+of testing it and building the docs.
+
+Please follow the instructions in [Testing](#testing) and [Documentation](#documentation) if
+you are unfamiliar with how to do so.
+
+The rest of the release process can be found in [these release instructions](./RELEASING.md).

LICENSE

@@ -0,0 +1,59 @@
+# Licensing terms
+
+This project is licensed under the terms of the Modified BSD License
+(also known as New or Revised or 3-Clause BSD), as follows:
+
+- Copyright (c) 2020-, Jupyter Development Team
+
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+Redistributions of source code must retain the above copyright notice, this
+list of conditions and the following disclaimer.
+
+Redistributions in binary form must reproduce the above copyright notice, this
+list of conditions and the following disclaimer in the documentation and/or
+other materials provided with the distribution.
+
+Neither the name of the Jupyter Development Team nor the names of its
+contributors may be used to endorse or promote products derived from this
+software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+## About the Jupyter Development Team
+
+The Jupyter Development Team is the set of all contributors to the Jupyter project.
+This includes all of the Jupyter subprojects.
+
+The core team that coordinates development on GitHub can be found here:
+https://github.com/jupyter/.
+
+## Our Copyright Policy
+
+Jupyter uses a shared copyright model. Each contributor maintains copyright
+over their contributions to Jupyter. But, it is important to note that these
+contributions are typically only changes to the repositories. Thus, the Jupyter
+source code, in its entirety is not the copyright of any single person or
+institution.  Instead, it is the collective copyright of the entire Jupyter
+Development Team.  If individual contributors want to maintain a record of what
+changes/contributions they have specific copyright on, they should indicate
+their copyright in the commit message of the change, when they commit the
+change to one of the Jupyter repositories.
+
+With this in mind, the following banner should be used in any source code file
+to indicate the copyright and license terms:
+
+    # Copyright (c) Jupyter Development Team.
+    # Distributed under the terms of the Modified BSD License.

MANIFEST.in

@@ -0,0 +1,34 @@
+include LICENSE
+include MANIFEST.in
+include requirements.txt
+include requirements-dev.txt
+include *.md
+include .bumpversion.cfg
+include tox.ini
+include pyproject.toml
+
+# Code and test files
+recursive-include nbclient *.ipynb
+recursive-include nbclient *.png
+recursive-include nbclient *.py
+
+# Documentation
+graft docs
+exclude docs/\#*
+exclude .readthedocs.yml
+exclude codecov.yml
+
+# Examples
+graft examples
+
+# docs subdirs we want to skip
+prune docs/build
+prune docs/gh-pages
+prune docs/dist
+
+# Patterns to exclude from any directory
+global-exclude *~
+global-exclude *.pyc
+global-exclude *.pyo
+global-exclude .git
+global-exclude .ipynb_checkpoints

README.md

@@ -1,2 +1,5 @@
 # nbclient
-A client library for executing notebooks. Formally a nbconvert's ExecutePreprocessor
+
+A client library for executing notebooks. Formally nbconvert's ExecutePreprocessor.
+
+## TODO: Add more details here!

RELEASING.md

@@ -0,0 +1,24 @@
+# Releasing
+
+## Prerequisites
+
+- First check that the CHANGELOG is up to date for the next release version
+- Ensure dev requirements are installed `pip install -r requirements-dev.txt`
+
+## Push to GitHub
+
+Change from patch to minor or major for appropriate version updates.
+
+```bash
+bumpversion patch
+git push && git push --tags
+```
+
+## Push to PyPI
+
+```bash
+rm -rf dist/*
+rm -rf build/*
+python setup.py sdist bdist_wheel
+twine upload dist/*
+```

docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+SPHINXPROJ    = nbclient
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/UPDATE.md

@@ -0,0 +1,5 @@
+TODO: Figure out make options needed for non-api changes
+
+```
+sphinx-apidoc -f -o reference ../nbclient
+```