voussoir/hnarchive
1
0
Fork 0
Code Issues Activity

Add note about update_items overwriting properties.

Browse source
This commit is contained in:
voussoir 2020-11-06 23:08:08 -08:00
parent 1a889a62ef
commit 955e1e3e0a
1 changed files with 9 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
README.md
View file

@ -7,7 +7,15 @@ Please `pip install requests` and `pip install voussoirkit`.
According to the [HN API docs](https://github.com/HackerNews/API) there is no enforced ratelimit, so just use a `threads` count that seems polite.
To get started, just run `python hnarchive.py update` and it will start from 1. In the future, you can run `update` on a cronjob or use `livestream` to get new items forever. Note, `update` always starts from the highest ID in the database. If you use `get` to get a range of IDs that is ahead of your update schedule, your next `update` will miss the skipped IDs.
To get started, just run `python hnarchive.py update` and it will start from 1. In the future, you can run `update` on a cronjob or use `livestream` to get new items forever.
Notes:
- `update` always starts from the highest ID in the database. If you use `get` to get a range of IDs that is ahead of your update schedule, your next `update` will miss the skipped IDs.
- `update_items` will overwrite previously fetched data with the new properties. Please know that HN moderators occasionally migrate comments between threads, adjust thread titles, etc. HN has a tight window in which authors can edit their own posts so you can expect actual item texts to remain pretty static outside of moderator action.
The exception is if an item is deleted and comes back as `None` from the server, then hnarchive keeps the old data.
Here are all of the subcommands: