Project Structure
Version Number
ngshare/version.py
defines the current version. It follows “Single-sourcing the package version”
Continuous Integration
.travis.yml
configures continuous integration for unit test and coverage test.
Documentation
docs/
directory contains source code for documentation. See Documentation.
Deployment
setup.py
is for installing and packaging this project.
Testing
testing/
contains setups used for testing ngshare, ngshare_exchange, nbgrader, and Z2JH.
testing/docker
contains a Docker environment for initial testing. It is slightly out of date and still uses our fork of ngshare rather than ngshare_exchange.
testing/minikube
contains a minikube environment. This is the main testing setup for local development, and it uses ngshare and ngshare_exchange on the local filesystem.
testing/install_jhmanaged
contains a Docker environment that demonstrates how a regular user would install ngshare and ngshare_exchange.
testing/install_z2jh
contains a minikube environment that demonstrates how a regular user would install ngshare and ngshare_exchange on a standard Kubernetes cluster.