Final Project Template

This repository contains a template for final projects.

How to Use this Template

Work in Binder

• Launch a live notebook server with the notebook using Binder:

Work in Colab

• Launch an executable version of the notebook using Google Colab:

Work locally (requires local installation of git and JupyterLab)

• Clone the repo using a shell (below) or GitHub Desktop

git clone https://github.com/py4ds/final-project
cd final-project
jupyter lab

Required packages

The packages used to run the code in the Binder instances are listed in requirements.txt (Note that some of these exact version numbers may not be available on your platform: you may have to tweak them for your own use).

Edit the requirements.txt file to meet the requirements of your project.

To install the requirements using pip, run the following at the command-line:

$ pip install --requirement requirements.txt

To install the requirements using conda, run the following at the command-line:

$ conda install --file requirements.txt

To create a stand-alone environment named final-project with Python 3.6 and all the required package versions, run the following:

$ conda create -n final-project python=3.6 --file requirements.txt

You can read more about using conda environments in the Managing Environments section of the conda documentation.

Git version control

To use git in a Binder instance, you have to set up your username and email as below:

git config --global user.name "John Doe"
git config --global user.email [email protected]

To avoid doing this every time you use Binder, include your username and email in the git_setup.sh file, which will be run via postBuild immediately after building the Binder instance.

Every time you need to update the version of the final-project.ipynb in your remote repo, run the following commands:

git add final-project.ipynb
git commit -m "Update final-project.ipynb"
git push

License

The code in this repository is released under the MIT license. Read more at the Open Source Initiative.