Skip to content

World Bank Data Lab Project Template v0.1.0

Compare
Choose a tag to compare
@g4brielvs g4brielvs released this 25 Aug 19:54
· 63 commits to main since this release
96ec3b9

World Bank Data Lab Project Template

The template is a standardized, but flexible project and documentation structure of folders and files for sharing your data science work.

Inspired by literate programming and the Cookiecutter Data Science, maintained by the World Bank Data Lab and built as GitHub template repository, the template contains:

  • README, CODE_OF_CONDUCT, CONTRIBUTING

    README files are important and often neglected. The files should provide anyone with information about the first steps to use, learn and contribute to your project.

  • LICENSE

    The LICENSE is a document that determines what others can and cannot do with contents of the repository. If no license is present, no one has permission to use and/or modify your code.

  • Issues and Pull Requests GitHub templates

    GitHub allows to customize how issues and pull requests are presented to the public. Custom templates encourage collaboration and maintainability.

  • docs/

    Documentation is often never priotized until last minute. The template aims to revert the malpractice by setting up the documentation as an integral part of the code repository. With the power of Jupyter Book, data practioners have a way to share Jupyter notebooks on GitHub Pages in a standardized and effortless way.

  • data/

    Placeholder folder for data. Data is immutable. By default, the data folder is present but ignored from version control, in order to prevent files of being mistakenly versioned in the code repository.

  • src/

    Placeholder folder for source code. If Python, it is recommended the package is made pip-installable.

  • notebooks/

    Placeholder folder for Jupyter notebooks. Markdown files and Jupyter notebooks can be added to docs/_toc.yml (Table of Contents) to compose the documentation.