Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

new(usr): Add first pass at Readwise API V3 (support for Reader) #13

Open
wants to merge 5 commits into
base: main
Choose a base branch
from

Conversation

joshbeckman
Copy link
Owner

Note that this is clearly still in beta (liable to change) because there are cases where the docs don't match the data (e.g. published_date).

Addresses #1

Note that this is clearly still in beta (liable to change) because there
are cases where the docs don't match the data (e.g. `published_date`).

Addresses #1
@joshbeckman joshbeckman added the enhancement New feature or request label Mar 3, 2024
@joshbeckman joshbeckman self-assigned this Mar 3, 2024
:parent_id, # both highlights and notes made in Reader are also considered Documents.
# Highlights and notes will have `parent_id` set, which is the Document id
# of the article/book/etc and highlight that they belong to, respectively.
keyword_init: true
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

btw if you can choose to only support Ruby 3.2 or newer then it defaults to keyword_init.

Copy link
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🤷🏼 It's not that burdensome to keep around. Ruby 3.0 isn't EOL until next year, I think.

@@ -3,19 +3,58 @@
require_relative 'book'
require_relative 'highlight'
require_relative 'tag'
require_relative 'document'
Copy link
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Warning

tODO: update the README with examples of these methods and a disclaimer that they are in beta and liable to change.

@@ -1,3 +1,5 @@
require 'readwise'
Copy link
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Warning

TODO: Write tests for the new methods

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants