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.2.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.2-py3-none-any.whl (74.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: bqmcp_cloud-0.1.2.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.2.tar.gz
Algorithm Hash digest
SHA256 a3bbefe979c783601b8450fd036ac89211cc58c85167b96fcc91da1c3c56df8d
MD5 93b37984a6858441ede850011e1b48a2
BLAKE2b-256 f0ce991310efbe8a34dfa35bf8cfa66cf7f1ffec7ccede6cff76539624c93c5c

See more details on using hashes here.

File details

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

File metadata

  • Download URL: bqmcp_cloud-0.1.2-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.2-py3-none-any.whl
Algorithm Hash digest
SHA256 2265989ee224c4a6b31d2520a13a9065ea8874143d18dcb83a35179577e2deb9
MD5 84d6337cda54fc3842290ea9ef690a77
BLAKE2b-256 9d96d8e862e5d919e966a3f093e681b1842cfe8ce665e4d696d59229ae2b2ff4

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