Code Monkey home page Code Monkey logo

going-beyond-with-jupyter-notebooks's Introduction

Going beyond with Jupyter notebooks

Why using Jupyter notebooks to publish packages

Jupyter notebook is a tool that combines text and code on the same file, this concept is called “literate programming” and it’s considered a programming paradigm focused on humans.

Jupyter notebook allows programmers to tell a story with their code

Although being a very well-regarded concept discussed by respected researchers like Donald Knuth, literate programming tools like Jupyter notebooks are considered inefficient for serious software development. This perception has limited Jupyter notebooks to simple python scripts and educational materials.

The Nbdev library has proven that literate programming is useful in developing big and serious projects, like FastAi. This tutorial will show attendees how to get the benefits of literate programming while also following software development best practices. We’ll get an hands-on experience in writing and publishing a Python Package while using Jupyter Notebooks. In addition to publishing the package, we’ll also learn how to deploy the docs, run simple tests and run them on CI/CD, making sure that our package will only get published if the tests pass.

Which package will be developed?

A French Deck, one of the most common decks in games, that contains 52 cards split between 4 suits.

The package will be used to develop a simple blackjack as a proof of concept.

Authoring

Ítalo Epifânio is a RnD Python Developer that has been working for the last couple years developing and publishing packages using nbdev.

Presentation

The tutorial presentation is available at the presentation folder. Run the presentation by using quarto preview presentation/index.qmd

You can install quarto from the official website or using nbdev CLI by running nbdev_install_quarto

Getting started

We recommend to create a virtual environment to install the dependencies required to create the presentation and run the included notebooks

  • python -m venv venv
  • source venv/bin/activate
  • pip install -e .[dev] or pip install nbdev jupyterlab matplotlib black ipytest ipywidgets

going-beyond-with-jupyter-notebooks's People

Contributors

itepifanio avatar unzerstort avatar

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.