Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mrWh1te/Botmation
A simple TypeScript framework for declaratively composing bots with Puppeteer
https://github.com/mrWh1te/Botmation
async-functionality bots composable-architecture curry declarative functional higher-order-functions nodejs npm-package puppeteer typescript web-crawler
Last synced: 3 months ago
JSON representation
A simple TypeScript framework for declaratively composing bots with Puppeteer
- Host: GitHub
- URL: https://github.com/mrWh1te/Botmation
- Owner: mrWh1te
- License: mit
- Created: 2020-01-23T18:41:13.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2024-08-10T01:46:35.000Z (5 months ago)
- Last Synced: 2024-11-01T12:37:06.286Z (3 months ago)
- Topics: async-functionality, bots, composable-architecture, curry, declarative, functional, higher-order-functions, nodejs, npm-package, puppeteer, typescript, web-crawler
- Language: TypeScript
- Homepage: https://botmation.dev
- Size: 7.96 MB
- Stars: 18
- Watchers: 1
- Forks: 2
- Open Issues: 42
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
[](https://travis-ci.com/mrWh1te/Botmation)
[](https://snyk.io/test/github/mrWh1te/Botmation?targetFile=package.json)
[](https://codecov.io/gh/mrWh1te/Botmation)
[](https://sonarcloud.io/dashboard?id=mrWh1te_Botmation)
[](https://david-dm.org/mrWh1te/Botmation)
# Introduction
[Botmation](https://botmation.dev) is a simple declarative framework for building bots in TypeScript using [Puppeteer](https://github.com/puppeteer/puppeteer). It follows a simple, composable pattern focused on a single type of function called a BotAction.
BotActions do everything, from simple tasks in crawling and scraping the web, to logging in & automating social media. They are composable, so they are easily assembled.
The possibilities are endless!
> “Everything should be made as simple as possible, but no simpler.” - Albert Einstein
Why choose Botmation?
---------------------
It empowers Puppeteer code with a simple pattern to maximize code readability, reusability and testability.
Its compositional design comes pre-built with safe defaults for building bots with less code.
It encourages a learn at your own pace approach to exploring the possibilities of Functional programming.
Its Core library has 100% test coverage.
# Getting Started
Botmation is a NodeJS library written in TypeScript. You'll need [node.js](http://nodejs.org/) LTS installed and the TypeScript compiler (`tsc`) installed globally (or have a transpiling code step).
Install
-------
To get started, install Botmation's main package with `npm`:
npm install --save @botmation/core
If you're just getting started, install `puppeteer`:
npm install --save puppeteer
You can install any other [@botmation packages](https://www.npmjs.com/org/botmation) to extend upon the available functionality:
npm install --save @botmation/instagram
Documentation
-------------
Figure out the details with [Botmation's Documentation](https://botmation.dev/) for a deep reference into every package's functions with examples.
Core Library Reference
----------------------
`@botmation/core` is the main package consisting of all functions in the API of [Botmation docs](https://botmation.dev/). It has the foundational functions for building bots and a little more. Other packages, like `@botmation/instagram` have specific functions that work in conjunction with the core ones.
Import any core API function from:
```javascript
import { chain, goTo, screenshot } from '@botmation/core'
```
`@botmation/core` v1 has 17 groups of BotActions to choose from:
- [abort](https://www.botmation.dev/api/abort)
- abort an assembly of `BotAction`'s
- [assembly-line](https://www.botmation.dev/api/assembly-lines)
- compose and run `BotAction`'s in lines
- [branching](https://www.botmation.dev/api/branching)
- functional branching i.e. if statement
- [console](https://www.botmation.dev/api/console)
- log messages to the nodeJS console
- [cookies](https://www.botmation.dev/api/cookies)
- read/write page cookies
- [errors](https://www.botmation.dev/api/errors)
- try/catch errors in assembly-lines
- [files](https://www.botmation.dev/api/files)
- write files to local disk ie screenshots, pdf's
- [indexed-db](https://www.botmation.dev/api/indexed-db)
- read/write to page's IndexedDB
- [inject](https://www.botmation.dev/api/inject)
- insert new injects into a line of `BotAction`'s
- [input](https://www.botmation.dev/api/input)
- simulate User input ie typing and clicking with a mouse
- [local-storage](https://www.botmation.dev/api/local-storage)
- read/write/delete from a page's Local Storage
- [loops](https://www.botmation.dev/api/loops)
- functional loops i.e. for each
- [navigation](https://www.botmation.dev/api/navigation)
- change the page's URL, wait for form submissions to change page URL, back, forward, refresh
- [pipe](https://www.botmation.dev/api/pipe)
- functions specific to Piping
- [random](https://www.botmation.dev/api/random)
- functions specific to randomness like rolling dice
- [scrapers](https://www.botmation.dev/api/scrapers)
- scrape HTML documents with an HTML parser and evaluate JavaScript inside a Page
- [time](https://www.botmation.dev/api/time)
- time based operations i.e. scheduling
Contributors
------------
### Code
[Michael Lage](https://github.com/mrWh1te) - [Blog](https://lage.tech)
### Art
[Patrick Capeto](https://www.instagram.com/patrick.capeto/) - [Email](mailto:[email protected])