Core: Added base code and tests

[Seluj78]

Ignore the version update check as this is the first version so it will be the first release

Summary by CodeRabbit

• New Features
  • Introduced automated workflows for building packages, deploying releases, and running tests across multiple operating systems and Python versions.
  • Added new pre-commit hooks for enhanced code quality checks.
  • Implemented a ShellHubApiError class for better error management in the ShellHub system.
  • Introduced classes for managing device information and operations within the ShellHub system.
• Documentation
  • Updated the README with a codecov badge and a detailed TODO list for future improvements.
• Tests
  • Added new test cases covering login functionality, device management, and error handling in the ShellHub application.
• Chores
  • Updated development requirements with necessary tools and libraries for type checking and testing.
• Refactor
  • Configured code style settings to ensure consistency and quality in code contributions.

[pep8speaks]

Hello @Seluj78! Thanks for updating this PR. We checked the lines you've touched for PEP 8 issues, and found:

There are currently no PEP 8 issues detected in this Pull Request. Cheers! 🍻

Comment last updated at 2024-02-07 10:21:30 UTC

[codecov]

Welcome to Codecov 🎉

Once merged to your default branch, Codecov will compare your coverage reports and display the results in this comment.

Thanks for integrating Codecov - We've got you covered ☂️

[Seluj78]

@coderabbitai review

[coderabbitai]

Warning

Rate Limit Exceeded

@Seluj78 has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 19 minutes and 22 seconds before requesting another review.

How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.
Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.
Please see our FAQ for further information.

Commits

Files that changed from the base of the PR and between 5ba3906 and ad99a1a.

Walkthrough

This update introduces a comprehensive suite of enhancements to a Python project, focusing on automation, code quality, and testing. It establishes workflows for building packages, deploying releases, and running tests across multiple environments. Additionally, it configures pre-commit hooks for better code practices and introduces a custom exception for handling API errors. The project's documentation and testing strategies are also set for future improvements, marking a significant leap towards a more robust and developer-friendly codebase.

Changes

Files	Change Summary
.github/workflows/...	Introduced workflows for building packages, deploying releases, and running tests.
.pep8speaks.yml, .pre-commit-config.yaml	Configured code style and pre-commit hooks for improved code quality.
README.md	Updated with codecov badge and a TODO list for future enhancements.
requirements-dev.txt	Added dependencies for type checking, testing, and package building.
shellhub/__init__.py, shellhub/exceptions.py	Exported ShellHubApiError and introduced a custom exception class.
shellhub/models/..., tests/...	Added models for ShellHub API interaction and tests for device management and base functionality.

"In the realm of code, where logic does play,
A rabbit hopped in, making bad bugs sway.
🐇 With each commit push, and merge on the way,
It whispered, 'Let's build, test, and deploy today!'"
🚀🌟

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-tests for this file.
• 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 tests 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 from git and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit tests.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

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 a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai help to get help.

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

CodeRabbit Configration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• The JSON schema for the configuration file is available here.
• 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

[coderabbitai]

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between 3283b0d and 5ba3906.

Files ignored due to path filters (3)

• codecov.yml is excluded by: !**/*.yml
• pyproject.toml is excluded by: !**/*.toml
• tox.ini is excluded by: !**/*.ini

Files selected for processing (14)

• .github/workflows/build_pkg.yml (1 hunks)
• .github/workflows/deploy.yml (1 hunks)
• .github/workflows/tests.yml (1 hunks)
• .pep8speaks.yml (1 hunks)
• .pre-commit-config.yaml (1 hunks)
• README.md (2 hunks)
• requirements-dev.txt (1 hunks)
• shellhub/init.py (1 hunks)
• shellhub/exceptions.py (1 hunks)
• shellhub/models/base.py (1 hunks)
• shellhub/models/device.py (1 hunks)
• tests/conftest.py (1 hunks)
• tests/test_base.py (1 hunks)
• tests/test_devices.py (1 hunks)

Files skipped from review due to trivial changes (1)

• shellhub/init.py

Additional comments: 13

shellhub/exceptions.py (1)

• 1-2: LGTM!

requirements-dev.txt (1)

• 4-16: LGTM!

.pep8speaks.yml (1)

• 1-4: LGTM!

.github/workflows/build_pkg.yml (1)

• 1-32: LGTM!

.pre-commit-config.yaml (1)

• 24-34: LGTM!

.github/workflows/deploy.yml (1)

• 1-36: LGTM!

tests/test_base.py (1)

• 1-37: LGTM!

.github/workflows/tests.yml (1)

• 1-55: LGTM!

tests/conftest.py (1)

• 1-55: LGTM!

README.md (1)

• 93-106: > 📝 NOTE

This review was outside the diff hunks and was mapped to the diff hunk with the greatest overlap. Original lines [3-106]

LGTM!

shellhub/models/base.py (1)

• 1-126: LGTM!

shellhub/models/device.py (1)

• 1-128: LGTM!

tests/test_devices.py (1)

• 1-279: LGTM!

[coderabbitai]

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between 5ba3906 and 8679a0d.

Files selected for processing (8)

• shellhub/init.py (1 hunks)
• shellhub/exceptions.py (1 hunks)
• shellhub/models/base.py (1 hunks)
• shellhub/models/device.py (1 hunks)
• tests/conftest.py (1 hunks)
• tests/test_base.py (1 hunks)
• tests/test_devices.py (1 hunks)
• tests/utils.py (1 hunks)

Files skipped from review due to trivial changes (1)

• tests/utils.py

Files skipped from review as they are similar to previous changes (5)

• shellhub/models/base.py
• shellhub/models/device.py
• tests/conftest.py
• tests/test_base.py
• tests/test_devices.py

Additional comments: 2

shellhub/exceptions.py (1)

• 1-14: The custom exception classes are correctly defined and follow Python's naming conventions for exceptions. Inheritance is properly used to create a hierarchy of exceptions. This setup allows for more granular exception handling in the project.

shellhub/__init__.py (1)

• 4-21: The import statements and the __all__ list are correctly updated to include the new exception classes, ensuring they are properly exported from the shellhub package. The version is appropriately set for the initial release.