Skip to main content

A cloud service for document processing and AI content generation

Project description

BQMCP Cloud

A cloud service for document processing and AI content generation, built on top of FastMCP.

Features

  • PDF document processing and content extraction
  • AI-powered content generation:
    • PPT generation
    • Title generation
    • Abstract generation
    • Quick read content
    • Mind map generation
    • Deep reading content
    • Release date extraction
    • PDF generation

Installation

pip install bqmcp-cloud

Usage

As a Python Package

from bqmcp_cloud import BQMCPCloud

# Initialize the cloud service
cloud = BQMCPCloud(
    api_key="your-openai-api-key",  # or set OPENAI_API_KEY environment variable
    proxy="your-proxy-url",         # or set HTTP_PROXY environment variable
    base_output_path="outputs",     # optional
    log_level="INFO",              # optional
    mcp_name="bigquant"            # optional
)

# Run the server
cloud.run(transport='stdio')  # or 'http'

Command Line Interface

# Basic usage
bqmcp-cloud

# With custom configuration
bqmcp-cloud --api-key "your-key" --proxy "your-proxy" --output-dir "custom-outputs" --log-level DEBUG

Configuration

The service can be configured through:

  1. Environment variables:

    • OPENAI_API_KEY: Your OpenAI API key
    • HTTP_PROXY: HTTP proxy URL
  2. Constructor parameters:

    • api_key: OpenAI API key
    • proxy: HTTP proxy URL
    • base_output_path: Base directory for output files
    • log_level: Logging level (DEBUG, INFO, WARNING, ERROR, CRITICAL)
    • mcp_name: Name for the MCP server
  3. Command line arguments:

    • --api-key: OpenAI API key
    • --proxy: HTTP proxy URL
    • --output-dir: Base output directory
    • --log-level: Logging level
    • --name: MCP server name
    • --transport: Transport type (stdio or http)

Development

  1. Clone the repository:
git clone https://github.com/yourusername/bqmcp-cloud.git
cd bqmcp-cloud
  1. Create a virtual environment:
python -m venv .venv
source .venv/bin/activate  # Linux/Mac
# or
.venv\Scripts\activate     # Windows
  1. Install development dependencies:
pip install -e ".[dev]"
  1. Run tests:
pytest

License

This project is licensed under the MIT License - see the LICENSE file for details.

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

bqmcp_cloud-0.1.3.tar.gz (36.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

bqmcp_cloud-0.1.3-py3-none-any.whl (74.3 kB view details)

Uploaded Python 3

File details

Details for the file bqmcp_cloud-0.1.3.tar.gz.

File metadata

  • Download URL: bqmcp_cloud-0.1.3.tar.gz
  • Upload date:
  • Size: 36.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.9

File hashes

Hashes for bqmcp_cloud-0.1.3.tar.gz
Algorithm Hash digest
SHA256 1a93d7c182440445769774338aecc1a0ef46f55c7d702d3bfa92d84b01455993
MD5 a45b95da090151e5267611be02c228e9
BLAKE2b-256 7ae692394219cda79549b2cdfd7a01b186dc923d31096d1c377f4471d35080e1

See more details on using hashes here.

File details

Details for the file bqmcp_cloud-0.1.3-py3-none-any.whl.

File metadata

  • Download URL: bqmcp_cloud-0.1.3-py3-none-any.whl
  • Upload date:
  • Size: 74.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.9

File hashes

Hashes for bqmcp_cloud-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 574be67cbfe1539cdabb608a4d538e85eefc2d7ded36d9b55e9f8ca52b8c77ce
MD5 5fa0feb1ee77140d47b117a187bed842
BLAKE2b-256 50ca5fc4ce9cd588b471e3a487259d78a8ecca16380cb2514083c745d3afceff

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page