https://github.com/lpredova/njuhalo
🐶 Customizable njuskalo.hr watcher
https://github.com/lpredova/njuhalo
go golang parser watcher
Last synced: 14 days ago
JSON representation
🐶 Customizable njuskalo.hr watcher
- Host: GitHub
- URL: https://github.com/lpredova/njuhalo
- Owner: lpredova
- License: mit
- Created: 2017-05-23T23:52:59.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2020-12-17T20:21:26.000Z (about 5 years ago)
- Last Synced: 2024-06-19T02:04:27.224Z (over 1 year ago)
- Topics: go, golang, parser, watcher
- Language: Go
- Homepage:
- Size: 139 MB
- Stars: 26
- Watchers: 4
- Forks: 3
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
new(/njuː/)halo
===========
Njuhalo is watcher written in Go.
It watches croatian online store [njuskalo](https://www.njuskalo.hr) and
notifies owner for new occurrences of wanted items that match filters in config.
It supports mailgun and slack notifications at the moment.
## Usage
Clone the repository !
```bash
$ git clone git@github.com:lpredova/njuhalo.git
```
Build the executable:
```bash
$ go build
```
or build it for specific architecture
```
env GOOS=target-OS GOARCH=target-architecture go build
```
where target-OS and target-architecture can be:
```
GOOS - Target Operating System GOARCH - Target Platform
android arm
darwin 386
darwin amd64
darwin arm
darwin arm64
dragonfly amd64
freebsd 386
freebsd amd64
freebsd arm
linux 386
linux amd64
linux arm
linux arm64
linux ppc64
linux ppc64le
linux mips
linux mipsle
linux mips64
linux mips64le
netbsd 386
netbsd amd64
netbsd arm
openbsd 386
openbsd amd64
openbsd arm
plan9 386
plan9 amd64
solaris amd64
windows 386
windows amd64
````
Run it:
```bash
$ ./njuhalo
```
Or you can copy it to /usr/local/bin/ to make it global:
```bash
$ cp njuhalo /usr/local/bin/
```
Now you can use it from anywhere by running from your cmd:
```bash
$ njuhalo
```
```bash
NAME:
njuhalo - Watcher for Njuskalo.hr items
USAGE:
njuhalo [global options] command [command options] [arguments...]
VERSION:
1.0.2
AUTHOR:
Lovro Predovan
COMMANDS:
init, initialize, i initialize configuration and database file in home dir
start, serve, s start monitoring njuskalo for items
add, query, a adds query to watch to config
clean, clear, c clears all query from config
print, p Prints currently active config file
list, l lists currently saved items
parse, r Runs parser only once
help, h Shows a list of commands or help for one command
GLOBAL OPTIONS:
--config value, --con value PATH to config file (default: "$HOME/.njuhalo/config.json")
--help, -h show help
--version, -v print the version
```
You need to configure your watcher how often do you want to run it.
Supported alerting channels are email and slack.
You can customize queries and filters so as intervals between fetching each page, because you don't want to send too many requests and act as an idiot.
### Configuration
Configuration file is located in your home directory:
```bash
$ {$HOME}/.njuhalo
```
There are two files, config.json and njuhalo.db. Config file is the one that is meant to be modified.
```javascript
{
"runIntervalMinutes": 1,
"sleepIntervalSeconds": 2,
"queries": [{
"baseQueryPath": "iznajmljivanje-stanova/zagreb",
"filters": {
"locationId": "2619",
"price[max]": "260",
"mainArea[max]": "50"
}
}],
"slack" : true,
"slackToken": "",
"slackChannelId" : "",
"slackNotificationColor": "#fdcd00",
"mail": true,
"to": "myemail@gmail.com",
"mailgunDomain":"",
"mailgunAPIKey":"",
"mailgunPublicKey":""
}
```
#### Create config file
If there is no such file you can create it manually or just run:
```bash
$ /.njuhalo i
```
#### Slack configuration
In order to configure slack notification you need to add token and channelId.
Token can be found here (if you don't have it, you must create it):
[https://api.slack.com/custom-integrations/legacy-tokens
](https://api.slack.com/custom-integrations/legacy-tokens)
To get channel ID simply enter web version of Slack and select wanted channel. After that simply copy last part of url:
[https://yourCompany.slack.com/messages/thisIsChannelId](https://yourCompany.slack.com/messages/thisIsChannelId)
### Adding queries
Adding queries can be pain in the ass so you can simply paste it like this
```bash
$ /.njuhalo a http://www.njuskalo.hr/path?query=1&query=2
```
That will parse query and save it to the default config file which also can be found on path:
```bash
$ {$HOME}/.njuhalo
```
Number of queries is not limited and you can add as much as you want.
If you messed up something, you can always clear all queries with clean option.
## Development
Location of all njuhalo config and db is in your home folder
```bash
$ {$HOME}/.njuhalo
```
To build binary from scratch:
```bash
$ go build
```
---
MIT License
Copyright (c) **Lovro Predovan**
2017