# PAB - APCloudy Deployment Tool
PAB is a command-line tool for deploying Scrapy spiders to APCloudy, similar to how `shub` works with Scrapinghub. It provides an easy way to manage and deploy your web scraping projects to the APCloudy platform.
## Features
- 🚀 Easy deployment of Scrapy spiders to APCloudy
- 🔐 Secure authentication and credential management
- 📦 Automatic project packaging and upload
- 📋 Project and spider management
- 🔄 Real-time deployment status tracking
- 🌟 Cross-platform support (Windows, macOS, Linux)
## Installation
You can install PAB using pip:
```bash
pip install pab-cli
```
Or install from source:
```bash
git clone https://github.com/fawadss1/pab-cli.git
cd pab-cli
pip install -e .
```
## Quick Start
### 1. Login to APCloudy
```bash
pab login
```
This will prompt you for your APCloudy API key and save it securely.
### 2. List Available Projects
```bash
pab projects
```
This will show you all available projects with their IDs.
### 3. Deploy a Spider
Navigate to your Scrapy project directory and run:
```bash
pab deploy <project-id>
```
For example:
```bash
pab deploy 5465
```
PAB will automatically package your project and deploy it to the specified project on APCloudy.
You can also specify additional options:
```bash
pab deploy 5465 --version v0.1.0 --target /path/to/project
```
## Commands
### Authentication
- `pab login` - Login to APCloudy with API key
- `pab logout` - Logout from APCloudy
- `pab status` - Show current authentication status
### Deployment
- `pab deploy <project-id>` - Deploy current project to specified APCloudy project
- `pab deploy <project-id> --version <version>` - Deploy with specific version tag
- `pab deploy <project-id> --target <path>` - Deploy from specific directory
### Project Management
- `pab projects` - List all available projects
- `pab spiders <project-id>` - List spiders in a project
## Configuration
PAB stores configuration in:
- Windows: `%APPDATA%\pab\pab_config.json`
- macOS/Linux: `~/.pab/pab_config.json`
## Examples
### Basic Usage
```bash
# Login to APCloudy
pab login
# List available projects to get project IDs
pab projects
# Deploy to project ID 5465
pab deploy 5465
# Check authentication status
pab status
# List spiders in a project
pab spiders 5465
```
### Advanced Usage
```bash
# Deploy with specific version
pab deploy 5465 --version production-2024
# Deploy from different directory
pab deploy 5465 --target /path/to/project
# Deploy with custom version and target
pab deploy 5465 --version v1.2.3 --target /my/scrapy/project
```
## API Endpoints
PAB communicates with APCloudy using the following API endpoints:
- `POST /api/cli/auth/authenticate` - API key authentication
- `POST /api/cli/auth/refresh` - Token refresh
- `GET /api/cli/projects` - List projects
- `POST /api/cli/projects/{id}/deploy` - Deploy spider
- `GET /api/cli/projects/{id}/spiders` - List spiders
- `GET /api/cli/deployments/{id}/status` - Deployment status
## Requirements
- Python 3.7+
- Scrapy 2.0+
- Valid APCloudy account and API key
## Contributing
1. Fork the repository
2. Create a 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](LICENSE) file for details.
## Support
For support, please contact:
- Email: Fawadstar6@gmail.com
- GitHub: [@fawadss1](https://github.com/fawadss1)
## Changelog
### v0.1.0
- Initial release
- Basic authentication and deployment functionality
- Project and spider management
- Cross-platform support
---
**Made with ❤️ by Fawad Ali for AskPablos**
Raw data
{
"_id": null,
"home_page": "https://github.com/fawadss1/pab-cli",
"name": "pab-cli",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "scrapy, spider, deployment, cloud, apcloudy",
"author": "Fawad Ali",
"author_email": "Fawad Ali <Fawadstar6@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/3c/4c/ea28e86893437763e45888dfe749fd14aa8d309338e131f3d05b8d6c9f29/pab_cli-0.1.0.tar.gz",
"platform": null,
"description": "# PAB - APCloudy Deployment Tool\r\n\r\nPAB is a command-line tool for deploying Scrapy spiders to APCloudy, similar to how `shub` works with Scrapinghub. It provides an easy way to manage and deploy your web scraping projects to the APCloudy platform.\r\n\r\n## Features\r\n\r\n- \ud83d\ude80 Easy deployment of Scrapy spiders to APCloudy\r\n- \ud83d\udd10 Secure authentication and credential management\r\n- \ud83d\udce6 Automatic project packaging and upload\r\n- \ud83d\udccb Project and spider management\r\n- \ud83d\udd04 Real-time deployment status tracking\r\n- \ud83c\udf1f Cross-platform support (Windows, macOS, Linux)\r\n\r\n## Installation\r\n\r\nYou can install PAB using pip:\r\n\r\n```bash\r\npip install pab-cli\r\n```\r\n\r\nOr install from source:\r\n\r\n```bash\r\ngit clone https://github.com/fawadss1/pab-cli.git\r\ncd pab-cli\r\npip install -e .\r\n```\r\n\r\n## Quick Start\r\n\r\n### 1. Login to APCloudy\r\n\r\n```bash\r\npab login\r\n```\r\n\r\nThis will prompt you for your APCloudy API key and save it securely.\r\n\r\n### 2. List Available Projects\r\n\r\n```bash\r\npab projects\r\n```\r\n\r\nThis will show you all available projects with their IDs.\r\n\r\n### 3. Deploy a Spider\r\n\r\nNavigate to your Scrapy project directory and run:\r\n\r\n```bash\r\npab deploy <project-id>\r\n```\r\n\r\nFor example:\r\n```bash\r\npab deploy 5465\r\n```\r\n\r\nPAB will automatically package your project and deploy it to the specified project on APCloudy.\r\n\r\nYou can also specify additional options:\r\n\r\n```bash\r\npab deploy 5465 --version v0.1.0 --target /path/to/project\r\n```\r\n\r\n## Commands\r\n\r\n### Authentication\r\n\r\n- `pab login` - Login to APCloudy with API key\r\n- `pab logout` - Logout from APCloudy\r\n- `pab status` - Show current authentication status\r\n\r\n### Deployment\r\n\r\n- `pab deploy <project-id>` - Deploy current project to specified APCloudy project\r\n- `pab deploy <project-id> --version <version>` - Deploy with specific version tag\r\n- `pab deploy <project-id> --target <path>` - Deploy from specific directory\r\n\r\n### Project Management\r\n\r\n- `pab projects` - List all available projects\r\n- `pab spiders <project-id>` - List spiders in a project\r\n\r\n## Configuration\r\n\r\nPAB stores configuration in:\r\n- Windows: `%APPDATA%\\pab\\pab_config.json`\r\n- macOS/Linux: `~/.pab/pab_config.json`\r\n\r\n## Examples\r\n\r\n### Basic Usage\r\n\r\n```bash\r\n# Login to APCloudy\r\npab login\r\n\r\n# List available projects to get project IDs\r\npab projects\r\n\r\n# Deploy to project ID 5465\r\npab deploy 5465\r\n\r\n# Check authentication status\r\npab status\r\n\r\n# List spiders in a project\r\npab spiders 5465\r\n```\r\n\r\n### Advanced Usage\r\n\r\n```bash\r\n# Deploy with specific version\r\npab deploy 5465 --version production-2024\r\n\r\n# Deploy from different directory\r\npab deploy 5465 --target /path/to/project\r\n\r\n# Deploy with custom version and target\r\npab deploy 5465 --version v1.2.3 --target /my/scrapy/project\r\n```\r\n\r\n## API Endpoints\r\n\r\nPAB communicates with APCloudy using the following API endpoints:\r\n\r\n- `POST /api/cli/auth/authenticate` - API key authentication\r\n- `POST /api/cli/auth/refresh` - Token refresh\r\n- `GET /api/cli/projects` - List projects\r\n- `POST /api/cli/projects/{id}/deploy` - Deploy spider\r\n- `GET /api/cli/projects/{id}/spiders` - List spiders\r\n- `GET /api/cli/deployments/{id}/status` - Deployment status\r\n\r\n## Requirements\r\n\r\n- Python 3.7+\r\n- Scrapy 2.0+\r\n- Valid APCloudy account and API key\r\n\r\n## Contributing\r\n\r\n1. Fork the repository\r\n2. Create a feature branch (`git checkout -b feature/amazing-feature`)\r\n3. Commit your changes (`git commit -m 'Add some amazing feature'`)\r\n4. Push to the branch (`git push origin feature/amazing-feature`)\r\n5. Open a Pull Request\r\n\r\n## License\r\n\r\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.\r\n\r\n## Support\r\n\r\nFor support, please contact:\r\n- Email: Fawadstar6@gmail.com\r\n- GitHub: [@fawadss1](https://github.com/fawadss1)\r\n\r\n## Changelog\r\n\r\n### v0.1.0\r\n- Initial release\r\n- Basic authentication and deployment functionality\r\n- Project and spider management\r\n- Cross-platform support\r\n\r\n---\r\n\r\n**Made with \u2764\ufe0f by Fawad Ali for AskPablos**\r\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A command-line tool for deploying Scrapy spiders to APCloudy",
"version": "0.1.0",
"project_urls": {
"Bug Tracker": "https://github.com/fawadss1/pab-cli/issues",
"Documentation": "https://github.com/fawadss1/pab-cli#readme",
"Homepage": "https://github.com/fawadss1/pab-cli",
"Repository": "https://github.com/fawadss1/pab-cli"
},
"split_keywords": [
"scrapy",
" spider",
" deployment",
" cloud",
" apcloudy"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "d1fd7d61e3d1df12d87b5f65b7df2a45a1b87e014a4a6d99aa8250ab37a5406b",
"md5": "8aa1983d9c8c4a32b85794aba78107ea",
"sha256": "b2289fe78e074e29e9c749c92a2d6a69849a2d6137f08c3c4c6e3126151ccc95"
},
"downloads": -1,
"filename": "pab_cli-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "8aa1983d9c8c4a32b85794aba78107ea",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 14214,
"upload_time": "2025-08-01T11:08:22",
"upload_time_iso_8601": "2025-08-01T11:08:22.072629Z",
"url": "https://files.pythonhosted.org/packages/d1/fd/7d61e3d1df12d87b5f65b7df2a45a1b87e014a4a6d99aa8250ab37a5406b/pab_cli-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "3c4cea28e86893437763e45888dfe749fd14aa8d309338e131f3d05b8d6c9f29",
"md5": "1b57a444824b39aad489e85d19dfb0ba",
"sha256": "8aff9a71e620609265911428252b541a829048857a24820185bab64eff0703dc"
},
"downloads": -1,
"filename": "pab_cli-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "1b57a444824b39aad489e85d19dfb0ba",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 14772,
"upload_time": "2025-08-01T11:08:23",
"upload_time_iso_8601": "2025-08-01T11:08:23.670718Z",
"url": "https://files.pythonhosted.org/packages/3c/4c/ea28e86893437763e45888dfe749fd14aa8d309338e131f3d05b8d6c9f29/pab_cli-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-08-01 11:08:23",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "fawadss1",
"github_project": "pab-cli",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [
{
"name": "click",
"specs": [
[
">=",
"8.0.0"
]
]
},
{
"name": "requests",
"specs": [
[
">=",
"2.32.4"
]
]
},
{
"name": "pyyaml",
"specs": [
[
">=",
"5.4.0"
]
]
},
{
"name": "colorama",
"specs": [
[
">=",
"0.4.4"
]
]
},
{
"name": "tabulate",
"specs": [
[
">=",
"0.8.9"
]
]
}
],
"lcname": "pab-cli"
}
JSON
