https://github.com/DormyMo/SpiderKeeper

admin ui for scrapy/open source scrapinghub
https://github.com/DormyMo/SpiderKeeper

dashboard scrapy scrapy-ui scrapyd scrapyd-dashboard scrapyd-ui spider

Last synced: 4 months ago
JSON representation

admin ui for scrapy/open source scrapinghub

• Host: GitHub
• URL: https://github.com/DormyMo/SpiderKeeper
• Owner: DormyMo
• Created: 2016-01-18T15:48:28.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2023-05-04T20:44:05.000Z (almost 2 years ago)
• Last Synced: 2024-10-29T15:29:13.597Z (4 months ago)
• Topics: dashboard, scrapy, scrapy-ui, scrapyd, scrapyd-dashboard, scrapyd-ui, spider
• Language: Python
• Homepage: http://sk.7mdm.com:5000/
• Size: 3.62 MB
• Stars: 2,739
• Watchers: 107
• Forks: 506
• Open Issues: 70
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md

Awesome Lists containing this project

• awesome-scrapy - SpiderKeeper

README

        
# SpiderKeeper

[![Latest Version](http://img.shields.io/pypi/v/SpiderKeeper.svg)](https://pypi.python.org/pypi/SpiderKeeper)

[![Python Versions](http://img.shields.io/pypi/pyversions/SpiderKeeper.svg)](https://pypi.python.org/pypi/SpiderKeeper)

[![The MIT License](http://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/DormyMo/SpiderKeeper/blob/master/LICENSE)

   

A scalable admin ui for spider service 

## Features

- Manage your spiders from a dashboard. Schedule them to run automatically

- With a single click deploy the scrapy project

- Show spider running stats

- Provide api

Current Support spider service

- [Scrapy](https://github.com/scrapy/scrapy) ( with [scrapyd](https://github.com/scrapy/scrapyd))

## Screenshot

![job dashboard](https://raw.githubusercontent.com/DormyMo/SpiderKeeper/master/screenshot/screenshot_1.png)

![periodic job](https://raw.githubusercontent.com/DormyMo/SpiderKeeper/master/screenshot/screenshot_2.png)

![running stats](https://raw.githubusercontent.com/DormyMo/SpiderKeeper/master/screenshot/screenshot_3.png)

## Getting Started

### Installing

```

pip install spiderkeeper

```

### Deployment

``` 

spiderkeeper [options]

Options:

  -h, --help            show this help message and exit

  --host=HOST           host, default:0.0.0.0

  --port=PORT           port, default:5000

  --username=USERNAME   basic auth username ,default: admin

  --password=PASSWORD   basic auth password ,default: admin

  --type=SERVER_TYPE    access spider server type, default: scrapyd

  --server=SERVERS      servers, default: ['http://localhost:6800']

  --database-url=DATABASE_URL

                        SpiderKeeper metadata database default: sqlite:////home/souche/SpiderKeeper.db

  --no-auth             disable basic auth

  -v, --verbose         log level

  

example:

spiderkeeper --server=http://localhost:6800

```

## Usage

```

Visit: 

- web ui : http://localhost:5000

1. Create Project

2. Use [scrapyd-client](https://github.com/scrapy/scrapyd-client) to generate egg file 

   scrapyd-deploy --build-egg output.egg

2. upload egg file (make sure you started scrapyd server)

3. Done & Enjoy it

- api swagger: http://localhost:5000/api.html

```

## TODO

- [ ] Job dashboard support filter

- [x] User Authentication

- [ ] Collect & Show scrapy crawl stats

- [ ] Optimize load balancing

## Versioning

We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/DormyMo/SpiderKeeper/tags). 

## Authors

- *Initial work* - [DormyMo](https://github.com/DormyMo)

See also the list of [contributors](https://github.com/DormyMo/SpiderKeeper/contributors) who participated in this project.

## License

This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details

## Contributing

Contributions are welcomed!

## 交流反馈

QQ群：

1群: 389688974（已满）

2群: 285668943

## 捐赠

![Contact](https://raw.githubusercontent.com/DormyMo/SpiderKeeper/master/screenshot/donate_wechat.png)