APCloudy

A Python client library for interacting with the APCloudy platform. This library provides a simple and intuitive interface for managing projects, spiders, and jobs on the APCloudy web scraping platform.

📚 Documentation

Complete documentation is available at apcloudy.readthedocs.io

Features

• Project Management: Create, update, and manage your APCloudy projects
• Spider Management: Deploy and manage web scraping spiders
• Job Management: Start, monitor, and manage scraping jobs
• Authentication: Secure API key-based authentication
• Error Handling: Comprehensive error handling with custom exceptions
• Rate Limiting: Built-in rate limiting support

Installation

Install apcloudy using pip:

pip install apcloudy

Quick Start

from apcloudy import APCloudyClient

# Initialize the client with your API key
client = APCloudyClient("your-api-key-here")

# Get all projects
projects = client.get_projects()

# Get a specific project
project = client.get_project("project-id")

# List spiders in a project
spiders = client.get_spiders("project-id")

# Start a job
job = client.start_job("project-id", "spider-name")

# Get job status
job_status = client.get_job("job-id")

API Reference

APCloudyClient

The main client class for interacting with the APCloudy API.

Methods

• get_projects(): List all projects
• get_project(project_id): Get a specific project
• get_spiders(project_id): List spiders in a project
• get_spider(project_id, spider_name): Get a specific spider
• start_job(project_id, spider_name, **kwargs): Start a new job
• get_job(job_id): Get job details
• get_jobs(project_id): List jobs for a project
• stop_job(job_id): Stop a running job

Models

• Project: Represents an APCloudy project
• Spider: Represents a spider within a project
• Job: Represents a scraping job
• JobState: Enumeration of possible job states

Exceptions

• APIError: Base exception for API errors
• AuthenticationError: Raised when authentication fails
• ProjectNotFoundError: Raised when a project is not found
• SpiderNotFoundError: Raised when a spider is not found
• JobNotFoundError: Raised when a job is not found
• RateLimitError: Raised when rate limits are exceeded

Development

Installing for Development

git clone https://github.com/yourusername/apcloudy.git
cd apcloudy
pip install -e ".[dev]"

Running Tests

pytest

Code Formatting

black apcloudy/
flake8 apcloudy/

Type Checking

mypy apcloudy/

Contributing

Contributions are welcome! Please feel free to submit a Pull Request. For major changes, please open an issue first to discuss what you would like to change.

1. Fork the repository
2. Create your feature branch (git checkout -b feature/amazing-feature)
3. Commit your changes (git commit -m 'Add some amazing feature')
4. Push to the branch (git push origin feature/amazing-feature)
5. Open a Pull Request

License

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

Support

If you encounter any issues or have questions, please file an issue on the GitHub repository.