Update quickstart with Git and source code tracking

[LeoRoccoBreedt]

Description

Include a summary of the changes and the related issue.

Related to: <ClickUp/JIRA task name>

Any expected test failures?

---

Add a [X] to relevant checklist items

❔ This change

• adds a new feature
• fixes breaking code
• is cosmetic (refactoring/reformatting)

---

✔️ Pre-merge checklist

• Refactored code (sourcery)
• Tested code locally
• Precommit installed and run before pushing changes
• Added code to GitHub tests (notebooks, scripts)
• Updated GitHub README
• Updated the projects overview page on Notion

---

🧪 Test Configuration

• OS:
• Python version:
• Neptune version:
• Affected libraries with version:

Summary by Sourcery

Integrate source code tracking into the quickstart examples by updating both the script and notebook to instantiate Run with a SourceTrackingConfig and setting the project parameter.

New Features:

• Add SourceTrackingConfig to enable git diffs, entry point, upstream diffs, and run command uploads in quickstart Run instantiation
• Specify the project parameter (“examples/quickstart”) when creating Run in the quickstart script and notebook

Enhancements:

• Align notebook example with script by importing and using SourceTrackingConfig in the quickstart notebook

[sourcery-ai]

Reviewer's Guide

This PR enhances the Quickstart guide by integrating source code tracking into both script and notebook examples via SourceTrackingConfig and standardizes experiment naming.

Class diagram for updated Run instantiation with SourceTrackingConfig

classDiagram
    class Run {
        +experiment_name: str
        +source_tracking_config: SourceTrackingConfig
        +project: str
        +add_tags(tags: List[str], group_tags: bool)
    }
    class SourceTrackingConfig {
        +upload_entry_point: bool
        +upload_diff_head: bool
        +upload_diff_upstream: bool
        +upload_run_command: bool
    }
    Run --> SourceTrackingConfig

Loading

File-Level Changes

Change	Details	Files
Integrate SourceTrackingConfig to enable source code tracking	Import SourceTrackingConfig in script and notebook examples Instantiate SourceTrackingConfig with entry point, diff, and run command flags Pass source_tracking_config (and project) to Run constructor	how-to-guides/quickstart/scripts/neptune_quickstart.py how-to-guides/quickstart/notebooks/neptune_quickstart.ipynb
Standardize experiment naming	Update experiment_name to “quickstart-script-experiment” in script Update experiment_name to “quickstart-notebook-experiment” in notebook	how-to-guides/quickstart/scripts/neptune_quickstart.py how-to-guides/quickstart/notebooks/neptune_quickstart.ipynb

---

Tips and commands

Interacting with Sourcery

• Trigger a new review: Comment @sourcery-ai review on the pull request.
• Continue discussions: Reply directly to Sourcery's review comments.
• Generate a GitHub issue from a review comment: Ask Sourcery to create an
  issue from a review comment by replying to it. You can also reply to a
  review comment with @sourcery-ai issue to create an issue from it.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a title at any time. You can also comment
  @sourcery-ai title on the pull request to (re-)generate the title at any time.
• Generate a pull request summary: Write @sourcery-ai summary anywhere in
  the pull request body to generate a PR summary at any time exactly where you
  want it. You can also comment @sourcery-ai summary on the pull request to
  (re-)generate the summary at any time.
• Generate reviewer's guide: Comment @sourcery-ai guide on the pull
  request to (re-)generate the reviewer's guide at any time.
• Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
  pull request to resolve all Sourcery comments. Useful if you've already
  addressed all the comments and don't want to see them anymore.
• Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
  request to dismiss all existing Sourcery reviews. Especially useful if you
  want to start fresh with a new review - don't forget to comment
  @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

• Enable or disable review features such as the Sourcery-generated pull request
  summary, the reviewer's guide, and others.
• Change the review language.
• Add, remove or edit custom review instructions.
• Adjust other review settings.

Getting Help

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[sourcery-ai]

Hey there - I've reviewed your changes and they look great!

---

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}

[cursor]

This PR is being reviewed by Cursor Bugbot

Details

Your team is on the Bugbot Free tier. On this plan, Bugbot will review limited PRs each billing cycle for each member of your team.

To receive Bugbot reviews on all of your PRs, visit the Cursor dashboard to activate Pro and start your 14-day free trial.