Skip to content

Adding python wrapper (py-carbone-connect) lib to the readme file.#13

Open
Piuliss wants to merge 1 commit intofleebzz:masterfrom
Piuliss:master
Open

Adding python wrapper (py-carbone-connect) lib to the readme file.#13
Piuliss wants to merge 1 commit intofleebzz:masterfrom
Piuliss:master

Conversation

@Piuliss
Copy link

@Piuliss Piuliss commented Oct 29, 2024

Python Wrapper for Carbone API

Overview

I've developed a Python client wrapper for the Carbone API to facilitate seamless integration with Python projects. The implementation provides a clean, type-hinted interface for interacting with Carbone's document generation services.

Current Features

  • Full TypeScript to Python implementation
  • Type hints support for better IDE integration
  • Proper error handling with custom exceptions
  • Support for both file path and file-like object inputs
  • Streaming response capabilities
  • MIME type auto-detection for templates

Implementation Details

  • Uses requests library for HTTP communications
  • Implements proper resource management (auto-closing files)
  • Follows Python best practices and PEP 8 guidelines

Roadmap

  • Add pip package setup
  • Implement comprehensive test suite
  • Add documentation and usage examples
  • CI/CD integration

Current Status

While the core functionality is implemented and working, this initial version could benefit from community feedback and contributions. The wrapper is already usable for basic integration needs.

@fleebzz Thank you for your collaboration and support with the main Docker API Carbone project. This Python wrapper aims to make Carbone more accessible to the Python community.

Feedback Welcome

I welcome any suggestions or feedback to improve this implementation, particularly regarding:

  • API design choices
  • Error handling approaches
  • Additional features needed
  • Documentation requirements

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant