docs: update installation guide in getting_started

[mvanwyk]

PR Type

Documentation

---

Description

• Added a detailed introduction to PyRetailScience in the getting_started guide.
• Provided step-by-step installation instructions using pip.
• Recommended the use of a virtual environment for installation.

---

Changes walkthrough 📝

	Relevant files
Documentation	installation.md Update installation guide with detailed instructions          docs/getting_started/installation.md Added a detailed introduction to PyRetailScience. Provided installation instructions using pip. Included a recommendation to use a virtual environment. +16/-1

---

💡 PR-Agent usage:
Comment /help on the PR to get a list of all available PR-Agent tools and their descriptions

Summary by CodeRabbit

• Documentation
  • Updated the installation guide for the PyRetailScience framework, providing a detailed introduction and installation instructions.
  • Added recommendations for using a virtual environment to enhance package management.

[coderabbitai]

Walkthrough

The documentation for the PyRetailScience framework has been significantly enhanced, moving from a simple placeholder to a comprehensive introduction and installation guide. This update clarifies the framework's capabilities in retail analytics and provides essential instructions for installation, including the use of virtual environments, thereby improving user experience.

Changes

Files	Change Summary
docs/getting_started/installation.md	Updated from placeholder to detailed introduction and installation guide for PyRetailScience, emphasizing its role in retail analytics and user installation instructions.

Poem

In fields of data, we hop and play,
With insights blooming, come what may.
The docs are fresh, the guides are bright,
Installation made easy, what a delight!
So gather 'round, let's learn and grow,
In retail's garden, together we'll flow! 🐇✨

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[qodo-code-review]

PR Reviewer Guide 🔍

⏱️ Estimated effort to review: 1 🔵⚪⚪⚪⚪

🧪 No relevant tests

🔒 No security concerns identified

⚡ No key issues to review

[qodo-code-review]

PR Code Suggestions ✨

No code suggestions found for PR.

[coderabbitai]

Actionable comments posted: 1

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 9290b86 and fa94349.

Files selected for processing (1)

• docs/getting_started/installation.md (1 hunks)

Additional context used

LanguageTool

docs/getting_started/installation.md

[uncategorized] ~3-~3: A punctuation mark might be missing here.
Context: ...ul framework for rapid bespoke and deep dive retail analytic. It equips you with a w...

(AI_EN_LECTOR_MISSING_PUNCTUATION)

Additional comments not posted (2)

docs/getting_started/installation.md (2)

7-13: LGTM!

The installation instructions are clear and well-structured.

---

14-16: LGTM!

The pip installation command is correct and follows best practices.

[coderabbitai]

Fix the punctuation issue.

Add a punctuation mark after "retail analytic" for better readability.

- PyRetailScience is a powerful framework for rapid bespoke and deep dive retail analytic. It equips you with a wide
+ PyRetailScience is a powerful framework for rapid bespoke and deep dive retail analytic. It equips you with a wide array of retail analytical capabilities, from segmentations to gain-loss analysis. Leave the mundane to us and elevate your role from data janitor to insights virtuoso.

Committable suggestion was skipped due to low confidence.

Tools

LanguageTool

[uncategorized] ~3-~3: A punctuation mark might be missing here.
Context: ...ul framework for rapid bespoke and deep dive retail analytic. It equips you with a w...

(AI_EN_LECTOR_MISSING_PUNCTUATION)