Add simple usage example

[joamag]

Summary

• add an example that demonstrates how to instantiate the Budy API, log in and create a voucher

Testing

• pytest -q

---

https://chatgpt.com/codex/tasks/task_e_684d3f7dd62c8328a0a40602bb475b98

Summary by CodeRabbit

• Documentation
  • Added an example usage section to the README, demonstrating how to use the module with Python code snippets.

[coderabbitai]

Walkthrough

An example usage section was added to the README.md file, illustrating how to use the budy module's API class for authentication and voucher creation. The update consists solely of documentation changes, with no modifications to code or public interfaces.

Changes

File(s)	Change Summary
README.md	Added an example usage section with Python code.

Poem

In README fields where docs reside,
A sample script now sits with pride.
Import, login, vouchers made—
Clear instructions, neatly laid.
With Python code, the way is shown,
For users now are not alone!
🐇✨

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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>, please review it.
  • Explain this complex logic.
  • 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 explain this code block.
  • @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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and explain its main purpose.
  • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 using 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 generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this 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.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

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.

[Copilot]

Pull Request Overview

This PR adds a usage example to the README that demonstrates instantiating the Budy API, logging in, and creating a voucher.

• Added a new Python usage example code block in the README.
• The example includes instantiating the API, executing the login, and creating a voucher.

Comments suppressed due to low confidence (1)

README.md:26

• The function name 'create_voucher_value' might be unclear since the PR description mentions creating a voucher. Consider renaming it to 'create_voucher' for consistency and clarity.

api.create_voucher_value(10)

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

README.md (1)

26-26: Capture and display the voucher response
To round out the snippet, assign the result of api.create_voucher_value(10) to a variable and print or inspect it:

- api.create_voucher_value(10)
+ voucher = api.create_voucher_value(10)
+ print(voucher)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between b127863 and 07f578c.

📒 Files selected for processing (1)

• README.md (1 hunks)

🔇 Additional comments (1)

README.md (1)

15-23: Clear and concise usage example
The new “Example” section effectively demonstrates how to instantiate the client and perform authentication. It’s a great addition to guide users through the basic workflow.