Initial 0.1.0 implementation

CHANGELOG.md

@@ -0,0 +1,5 @@
+# Change Log
+
+## 0.1.0
+
+- Initial Release!

CONTRIBUTING.md

@@ -0,0 +1,100 @@
+# So You Want to Contribute to Scrapbook!
+We welcome all contributions to Scrapbook both large and small. We encourage you to join our community.
+
+## Our Community Values
+
+We are an open and friendly community. Everybody is welcome.
+
+We encourage friendly discussions and respect for all. There are no exceptions.
+
+All contributions are equally important. Documentation, answering questions, and fixing bugs are equally as valuable as adding new features.
+
+Please read our entire code of conduct [here](https://github.com/nteract/nteract/blob/master/CODE_OF_CONDUCT.md). Also, check out the for the [Python](https://github.com/nteract/nteract/blob/master/CODE_OF_CONDUCT.md) code of conduct.
+
+## Setting up Your Development Environment
+Following these instructions should give you an efficient path to opening your first pull-request.
+
+### Cloning the Scrapbook Repository
+Fork the repository to your local Github account. Clone this repository to your local development machine.
+```
+git clone https://github.com/<your_account>/scrapbook
+cd scrapbook
+```
+
+### Install an Editable Version
+We prefer to use [conda](https://conda.io/docs/user-guide/tasks/manage-environments.html) to manage the development environment.
+```
+conda create -n dev
+. activate env
+```
+or [virtualenv](https://packaging.python.org/guides/installing-using-pip-and-virtualenv/) if you prefer.
+```
+python3 -m virtualenv dev
+source dev/bin/activate
+```
+
+Install Scrapbook using:
+```
+pip install -e .[dev]
+```
+
+_Note: When you are finished you can use `source deactivate` to go back to your base environment._
+
+### Running Tests Locally
+
+We need to install the development package before we can run the tests. If anything is confusing below, always resort to the relevant documentation.
+```
+pytest --pyargs scrapbook
+```
+The `pyargs` option allows `pytest` to interpret arguments as python package names. An advantage is that `pytest` will run in any directory, and this approach follows the `pytest` [best practices](https://docs.pytest.org/en/latest/goodpractices.html#tests-as-part-of-application-code).
+
+Now there should be a working and editable installation of Scrapbook to start making your own contributions.
+
+## So You're Ready to Pull Request
+
+The general workflow for this will be:
+1. Run local tests
+2. Pushed changes to your forked repository
+3. Open pull request to main repository
+
+### Run Tests Locally
+
+```
+pytest --pyargs scrapbook
+```
+
+Run check manifest to ensure all files are accounted for in the repository.
+```
+check-manifest
+```
+This commands read the `MANIFEST.in` file and explicitly specify the files to include in the source distribution. You can read more about how this works [here](https://docs.python.org/3/distutils/sourcedist.html).
+
+### Push Changes to Forked Repo
+
+Your commits should be pushed to the forked repository. To verify this type ```git remote -v``` and ensure the remotes point to your GitHub. Don't work on the master branch!
+
+1. Commit changes to local repository:
+    ```
+    git checkout -b my-feature
+    git add <updated_files>
+    git commit
+    ```
+2. Push changes to your remote repository:
+    ```
+    git push -u origin my-feature
+    ```
+
+### Create Pull Request
+
+Follow [these](https://help.github.com/articles/creating-a-pull-request-from-a-fork/) instrucutions to create a pull request from a forked repository. If you are submitting a bug-fix for a specific issue make sure to reference the issue in the pull request.
+
+There are good references to the [Git documentation](https://git-scm.com/doc) and [Git workflows](https://docs.scipy.org/doc/numpy/dev/gitwash/development_workflow.html) for more information if any of this is unfamiliar.
+
+_Note: You might want to set a reference to the main repository to fetch/merge from there instead of your forked repository. You can do that using:_
+```
+git remote add upstream https://github.com/nteract/scrapbook
+```
+
+It's possible you will have conflicts between your repository and master. Here, `master` is meant to be synchronized with the ```upstream``` repository.  GitHub has some good [documentation](https://help.github.com/articles/resolving-a-merge-conflict-using-the-command-line/) on merging pull requests from the command line.
+
+Happy hacking on Scrapbook!

MANIFEST.in

@@ -0,0 +1,27 @@
+recursive-include papermill *.py
+recursive-include papermill *.ipynb
+recursive-include papermill *.json
+recursive-include papermill *.yaml
+recursive-include papermill *.keep
+recursive-include papermill *.txt
+
+include setup.py
+include setup.cfg
+include requirements.txt
+include requirements-dev.txt
+include pytest.ini
+include LICENSE
+include MANIFEST.in
+include *.md
+include *.toml
+
+include .coveragerc
+
+# Documentation
+graft docs
+# exclude build files
+prune docs/_build
+# exclude sample notebooks for binder
+prune binder/
+# Scripts
+graft scripts

RELEASING.md

@@ -0,0 +1,21 @@
+# Releasing
+
+## Pre-requisites
+
+- First check that the CHANGELOG is up to date for the next release version
+- Ensure `bumpversion`, `wheel>=0.31.0`, `setuptools>=38.6.0`, and `twine>=1.11.0` (or long readme will be malformed)
+
+## Push to github
+
+```
+bumpversion patch setup.py
+git push && git push --tags
+```
+
+## Push to PyPi
+
+```
+rm -rf dist/*
+python setup.py sdist bdist_wheel
+twine upload dist/*
+```