Feat/initial structure

[joamag]

This pull request introduces a significant number of changes to set up the project structure, workflows, and initial implementation of the Colony Print API client. The most important changes include the addition of GitHub workflows for deployment and testing, the setup of project configuration files, and the initial implementation of the API client and its components.

GitHub Workflows:

• .github/workflows/deploy.yml: Added a deploy workflow triggered by tag pushes, which includes steps for building, testing, and uploading the package to PyPI.
• .github/workflows/main.yml: Added a main workflow triggered by pushes, which includes steps for building and testing across multiple Python versions and PyPy.

Project Configuration:

• .project: Added project configuration for Eclipse with PyDev nature.
• .pydevproject: Added PyDev project settings for Eclipse.
• pytest.ini: Added pytest configuration to specify test file patterns and test paths.
• setup.cfg: Added setup configuration for building a universal wheel.
• setup.py: Added setup script for the Colony Print API client package, including metadata and dependencies.

API Client Implementation:

• src/colony_print/__init__.py: Added initialization of the Colony Print API module.
• src/colony_print/base.py: Implemented the base API class with methods for building requests and a ping method.
• src/colony_print/node.py: Implemented the NodeAPI class with methods for listing nodes and printing jobs.
• src/colony_print/scripts/printer.py: Added a script for printing a test message using the API client.

Documentation and Metadata:

• CHANGELOG.md: Added a changelog file adhering to the Keep a Changelog format.
• README.md: Updated the README file with a proper title and description.
• src/colony_print/test/__init__.py: Added initial test module with licensing information.

Summary by CodeRabbit

Release Notes

• New Features

  • Added GitHub Actions workflows for automated testing and deployment
  • Introduced Python API client for Colony Print
  • Implemented node and job management functionality

• Infrastructure

  • Added configuration files for project setup
  • Configured pytest for testing
  • Updated dependency management with requirements.txt

• Documentation

  • Created README.md and CHANGELOG.md
  • Added type hints and type checking support

• Testing

  • Set up comprehensive test infrastructure across multiple Python versions
  • Added initial test cases

• Chores

  • Updated .gitignore to exclude development and build artifacts
  • Added project configuration files for development environments

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

The pull request introduces a comprehensive setup for the Colony Print API project, establishing a robust development and deployment infrastructure. It includes GitHub Actions workflows for continuous integration and deployment, configuration files for various development environments, and a complete Python package structure. The project now supports multiple Python versions, includes type hints, and provides example applications and scripts for interacting with the Colony Print API.

Changes

File	Changes
.github/workflows/	Added deploy.yml and main.yml for CI/CD with multi-version testing
.gitignore	Added Python, macOS, and build-related ignore patterns
setup.py, setup.cfg	Configured package metadata, wheel distribution, and dependencies
src/colony_print/	Added core API implementation modules with base, node, and job functionality
src/examples/	Introduced example web application and API interaction scripts
src/colony_print/test/	Added initial test infrastructure
Configuration Files	Added .project, .pydevproject, pytest.ini, requirements.txt
Documentation	Updated README.md, added CHANGELOG.md

Poem

🐰 A Rabbit's Ode to Colony Print API

Workflows dance, versions align,
Python's magic starts to shine,
From nodes to jobs, our code takes flight,
With CodeRabbit's testing might! 🚀
Deploy, my friends, with pure delight!

---

📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between e1b6cab and 7fb029f.

📒 Files selected for processing (27)

• .github/workflows/deploy.yml (1 hunks)
• .github/workflows/main.yml (1 hunks)
• .gitignore (1 hunks)
• .project (1 hunks)
• .pydevproject (1 hunks)
• .settings/org.eclipse.core.resources.prefs (1 hunks)
• CHANGELOG.md (1 hunks)
• README.md (1 hunks)
• pytest.ini (1 hunks)
• requirements.txt (1 hunks)
• setup.cfg (1 hunks)
• setup.py (1 hunks)
• src/colony_print/__init__.py (1 hunks)
• src/colony_print/base.py (1 hunks)
• src/colony_print/base.pyi (1 hunks)
• src/colony_print/job.py (1 hunks)
• src/colony_print/job.pyi (1 hunks)
• src/colony_print/node.py (1 hunks)
• src/colony_print/node.pyi (1 hunks)
• src/colony_print/scripts/__init__.py (1 hunks)
• src/colony_print/scripts/printer.py (1 hunks)
• src/colony_print/test/__init__.py (1 hunks)
• src/colony_print/test/base.py (1 hunks)
• src/examples/__init__.py (1 hunks)
• src/examples/app.py (1 hunks)
• src/examples/base.py (1 hunks)
• src/examples/base.pyi (1 hunks)

Finishing Touches

• 📝 Generate Docstrings (Beta)

---

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>, please review it.
  • 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 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 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 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. (Beta)
• @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.