Recent Releases of template

template - v24.09.2

What's Changed

  • Update README by @g4brielvs in https://github.com/worldbank/template/pull/66

Full Changelog: https://github.com/worldbank/template/compare/v24.09.1...v24.09.2

- Jupyter Notebook
Published by g4brielvs over 1 year ago

template - v24.09.1

What's Changed

  • Update PyPI URL by @g4brielvs in https://github.com/worldbank/template/pull/64
  • Upgrade release workflow by @g4brielvs in https://github.com/worldbank/template/pull/65

Full Changelog: https://github.com/worldbank/template/compare/v24.09.0...v24.09.1

- Jupyter Notebook
Published by g4brielvs over 1 year ago

template - v24.09.0

What's Changed

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

Full Changelog: https://github.com/worldbank/template/compare/v24.03.0...v24.09.0

- Jupyter Notebook
Published by g4brielvs over 1 year ago

template - v24.03.0

What's Changed

  • [pre-commit.ci] pre-commit autoupdate by @pre-commit-ci in https://github.com/worldbank/template/pull/39
  • Migrate to Hatch by @g4brielvs in https://github.com/worldbank/template/pull/40
  • Add Dependabot by @g4brielvs in https://github.com/worldbank/template/pull/43

New Contributors

  • @pre-commit-ci made their first contribution in https://github.com/worldbank/template/pull/39

Full Changelog: https://github.com/worldbank/template/compare/v2024.1.0...v24.03.0

- Jupyter Notebook
Published by g4brielvs about 2 years ago

template - v2024.1.0

What's Changed

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

New Contributors

  • @dependabot made their first contribution in https://github.com/worldbank/template/pull/31

Full Changelog: https://github.com/worldbank/template/compare/v0.1.0...v2024.1.0

- Jupyter Notebook
Published by g4brielvs over 2 years ago

template - 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, CODEOFCONDUCT, 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.

- Jupyter Notebook
Published by g4brielvs almost 4 years ago