Git Product home page Git Product logo

dsc-project-template's Introduction

Phase 1 Project Templates and Examples

This repo contains templates and examples to help you get started with your Phase 1 Project. Each of these is in a separate branch as explained below.

  • The template-mvp branch is the template you should use to for your Phase 1 Project. MVP stands for Minimum Viable Product, but this isn't meant in a negative way - if your project uses this template, it will be functional and accessible.

  • The example-mvp branch is an example project using the MVP template.

Once you've completed your project using the MVP template, you can improve it using the Above and Beyond (AAB) template if you have time:

  • The template-aab branch is the AAB template to use to keep improving your project.

  • The example-aab branch is an example project using the AAB template.

dsc-project-template's People

Contributors

aapeebles avatar davidbraslow avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

dsc-project-template's Issues

Separate .py files from images

This may come down to personal preference, but I think it is best to have a folder containing all .py files and separate folders for images and data.

Moving forward, this would allow instructors to show students how to organize a module of .py files into submodules and how to import from those submodules.

It might make sense to keep to the current structure for mod 1, create a folder for all .py files in mod 2, create submodules in mod3, etc.

Create repo from scratch

Once students have been introduced to this repo organization, I think either in mod 2 or 3 students should be walked through the process of creating a project repo from scratch.

Because the majority of their work, including their end of mod projects, involve forking a learn repo, I've found that students often do not know how to create a project from scratch. (ie create an empty github repo and push to it)

Personal preference is to work hub into the workflow to encourage students to use the command line. Also aliasing, but that isn't as important

Thinking about this, it might make sense to create a PyPI package that would initiate a vanilla data science repository structure. I would love that for my own life, would probably lead to more organized student repos, and would be a nice tool for students after graduating.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.