v24.09.2

What's Changed

• Update README by @g4brielvs in #66

Full Changelog: v24.09.1...v24.09.2

v24.09.1

What's Changed

• Update PyPI URL by @g4brielvs in #64
• Upgrade release workflow by @g4brielvs in #65

Full Changelog: v24.09.0...v24.09.1

v24.09.0

What's Changed

• [pre-commit.ci] pre-commit autoupdate by @pre-commit-ci in #41
• [pre-commit.ci] pre-commit autoupdate by @pre-commit-ci in #45
• Migrate deployment to GitHub Actions by @g4brielvs in #50
• [pre-commit.ci] pre-commit autoupdate by @pre-commit-ci in #51
• [pre-commit.ci] pre-commit autoupdate by @pre-commit-ci in #56
• [pre-commit.ci] pre-commit autoupdate by @pre-commit-ci in #57
• Update instructions to use GitHub Actions option by @g4brielvs in #61
• Add Python Package Management section by @g4brielvs in #63
• [pre-commit.ci] pre-commit autoupdate by @pre-commit-ci in #62

Full Changelog: v24.03.0...v24.09.0

v24.03.0

What's Changed

• [pre-commit.ci] pre-commit autoupdate by @pre-commit-ci in #39
• Migrate to Hatch by @g4brielvs in #40
• Add Dependabot by @g4brielvs in #43

New Contributors

• @pre-commit-ci made their first contribution in #39

Full Changelog: v2024.1.0...v24.03.0

v2024.1.0

What's Changed

• Secrets best practices by @g4brielvs in #5
• Conforming to PEP 518 by @g4brielvs in #8
• Migrate to actions/setup-python by @g4brielvs in #9
• Change execute notebooks off by @g4brielvs in #10
• Upgrade Jupyter Book by @g4brielvs in #15
• Fix typos by @g4brielvs in #24
• Add Gallery by @g4brielvs in #26
• Update templating text by @g4brielvs in #28
• Bump jupyter-book from 0.15.1 to 1.0.0 in /docs by @dependabot in #31
• Update Action by @g4brielvs in #32
• Set up pre-commit by @g4brielvs in #37
• Change Versioning by @g4brielvs in #38

New Contributors

• @dependabot made their first contribution in #31

Full Changelog: v0.1.0...v2024.1.0

World Bank Data Lab Project Template v0.1.0

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.