Overview

We're looking for contributors to help expand our collection of Jupyter notebooks (cookbooks) that demonstrate various AI and automation tasks using Julep's features. This is a great opportunity for newcomers to get familiar with Julep and contribute to the project!

Objectives

Replicate existing cookbooks to ensure they're up-to-date and functioning correctly.
Create new cookbooks based on the ideas listed in the cookbooks/README.md file.

Tasks

1. Replicating Existing Cookbooks

Choose one or more of the existing cookbooks from the list in cookbooks/README.md.
Follow the instructions in the notebook to run it in Google Colab.
Verify that all cells execute without errors and produce the expected outputs.
If you encounter any issues or outdated information, document them for updating.

2. Creating New Cookbooks

Select an idea from the "Potential Cookbooks for Contributors" section in cookbooks/README.md.
Create a new Jupyter notebook following the structure of existing cookbooks.
Implement the chosen use case using Julep's features.
Ensure your notebook includes:
- A clear introduction and overview of the task
- Step-by-step implementation with explanations
- Proper error handling and user guidance
- A conclusion summarizing the key learnings

Guidelines for Creating New Cookbooks

Naming Convention: Name your notebook following the pattern XX-Descriptive_Name.ipynb, where XX is the next available number in the sequence.
Structure:
- Start with an introduction explaining the purpose of the cookbook.
- Include a cell for installing the Julep client.
- Create sections for each major step (e.g., Creating an Agent, Defining a Task, Creating an Execution).
- Add markdown cells to explain concepts and code.
Code Quality:
- Ensure your code is well-commented and follows PEP 8 style guidelines.
- Use meaningful variable names.
- Handle potential errors gracefully.
Documentation:
- Explain each step clearly, assuming the reader is new to Julep.
- Include links to relevant Julep documentation where appropriate.
Testing:
- Test your notebook thoroughly in Google Colab to ensure it runs without errors.
- Include sample outputs where relevant.
Update README.md:
- Add your new cookbook to the table in cookbooks/README.md.
- Include a brief description and mark it as implemented.

How to Contribute

Fork the repository.
Create a new branch for your cookbook (e.g., cookbook/weather-notification-service).
Develop your cookbook following the guidelines above.
Test your notebook thoroughly.
Commit your changes and push to your fork.
Open a pull request with a clear description of your contribution.

Resources

Need Help?

If you have any questions or need assistance, please don't hesitate to ask in the comments of this issue or reach out on our Discord channel.

We're excited to see your contributions and help grow the Julep cookbook collection!

Weather-Based Notification Service Description: Checks the weather forecast daily and notifies users about severe weather conditions in their area. Features: Tools: weather, sendgrid Step Types: Tool Call, Conditional Logic, Send Email, Schedule (Sleep)

DarkZelda11 commented 1 week ago

Hi, I am a new and upcoming programmer studying my qualification, part of my qualification requires me to contribute to an open-source project. I like the look and feel of your project and would like to you assign this issue to me so that I may offer my services.

Thank you in advance.

CGaneshKumar2002 commented 1 week ago

Hi @ijindal1, Can you assign this ticket as per your comment? I'd appreciate it, Thanks!

ijindal1 commented 1 week ago

Done @CGaneshKumar2002

ijindal1 commented 1 week ago

@DarkZelda11 - Can you please pick a different example?

https://github.com/julep-ai/julep/issues/558