(aka the "awesome-notebooks")
The objective of this repository is to create the largest catalog of production-ready Jupyter Notebooks templates. With those templates, it becomes easy to create data products (analytical dashboards, automation/AI engines and more).
Each of these templates adheres to a consistent framework, designed to expedite your coding process. While these templates are designed for ease of use, some may require data science skills for setup, particularly those that interface with third-party tools via API. These templates can function independently, but they also serve as integral components of data products. Consider them as the essential parts needed to assemble your 'car engine'. By developing these templates and ensuring their standalone functionality, we streamline the process of data product development, as we already comprehend the operation of some parts within it.
All templates are readily accessible on GitHub or via Naas Search.
To ensure the quality of the templates, we have defined a framework. Each notebook shall be organized as follow.
At the top of the notebook, you'll find a link for providing feedback on the notebook you're using. This could be:
Upon clicking this link, you'll be redirected to a Google form where you can provide more information. We will endeavor to contact the notebook creator for improvements or seek community assistance during our bi-monthly community calls that aim to create new templates or enhance existing ones.
Since all our templates are open-source, errors may occasionally occur. We apologize for any inconvenience that may cause and request your support in reporting these issues to help us rectify them. To report a bug, click on the link at the top of the notebook. You will be redirected to GitHub to create an issue. Please attach screenshots to help us understand the bug, and provide any other information that could assist us in reproducing the issue. We will strive to respond as quickly as possible to resolve the issue.
Register for the Open Source Contributor Program so we can add you to the team of contributors in the Naas GitHub organization.
To start working on our repository, you MUST be a part of our open-source contributors team.
Please check your email and validate the invitation before you begin working on a new issue.
# First, clone the repository
git clone https://github.com/jupyter-naas/awesome-notebooks.git
# Navigate into the cloned directory
cd awesome-notebooks
# Fetch all branches from the repository
git fetch
# Checkout to the specific branch you want
git checkout branch_name
If a draft of a template (generated with our AI system) has been already created, you can directly start working on it. Otherwise, you kick start manually:
Toolname_Function.ipynb
.Start working on your notebook. Commit your work every time you make significant progress. You can use the UI interface inside your Naas Lab server to do this.
# Navigate into the cloned directory
cd awesome-notebooks
# Add new template
git add Tool/Tool_Your_template.ipynb
# Commit with message
git commit -m "feat: xxxx"
# Push your work
git push
Open a Pull Request and add a Templates Maintainer as Reviewer: Florent (@FlorentLvr).
Once merged, promote your work on LinkedIn, Twitter, and other social media channels! (Optional, but people need to know you are awesome 😉). Explain why you did this notebook and how it could be useful. You can use the certificate generated once the PR is merged to display your work and add the tag open source contributor on your LinkedIn profile. We will be happy to have you in our community.
Thank you!
If you want to contribute more frequently to Naas, you can become a templates maintainer. This status will offer you the right to be sponsored by Naas for your contributions done every month, ranging from $50 to $250. To become a templates maintainer, you must have completed at least 5 notebooks (which ensures you've mastered our process) and created 5 social media content promoting your template or Naas.
Then, you will be introduced to our template maintainer program and will have a dedicated team with the core team to assist you in developing integrations, automations, or AI systems.
We are committed to sharing templates and giving shout outs to the contributors on our social media platforms, you can support us on: