@mikestreety/data-collector

Data Collector

Built with https://oclif.io/

• Data Collector
  • Installation
    • Global
  • Services
    • Webmentions
    • RSS
    • Letterboxd
  • Roadmap
  • Releasing

Installation

npm i @mikestreety/data-collector

You can then access it with the following:

./node_modules/.bin/datacollector

In your package.json, you can add specific commands or a shortcut to the main command

"scripts": {
  "datacollector": "datacollector"
},

With this set, you can pass in your commands to a slightly shorter (and more memorable) command:

npm run datacollector -- letterboxd letterboxd.json -u mikestreety

Global

You can install it globally if you wish

npm i -g @mikestreety/data-collector

Which would allow you to run datacollector in your terminal

Services

Webmentions

• -d, --domain - the domain to get the webmentions from
• -t, --token - your webmentions token from https://webmention.io/settings

datacollector webmentions webmentions.json --domain www.mikestreety.co.uk --token 123456

Code adapted from Max Böck's 11ty Webmentions repo

RSS

Any RSS feed provided (or searches for RSS) of a given domain

• -f, --feed - the RSS feed
• -d, --domain - the domain to search for the RSS feeds

datacollector letterboxd rss.json -f https://www.mikestreety.co.uk/rss-notes.xml

or

datacollector letterboxd rss.json -d www.mikestreety.co.uk

Letterboxd

Get the films for a user from letterboxd

• -u, --username - the Letterboxd username

datacollector letterboxd letterboxd.json -u mikestreety

Roadmap

• Allow .env files
• Create oAuth workflow
• Add Strava

Releasing

Once ready to release, run the following

• npm version (major|minor|patch)
• npm publish