fix: Update get_articles method to accept integer cursor

[yazdipour]

Summary by Sourcery

This pull request updates the get_articles method to accept an integer cursor for pagination, fixing a bug. Additionally, it clarifies the method's documentation regarding the maximum number of articles that can be fetched and the cursor parameter.

• Bug Fixes:
  • Updated the get_articles method to accept an integer cursor instead of a string for pagination.
• Documentation:
  • Clarified the documentation for the get_articles method, specifying the maximum number of articles that can be fetched and updating the cursor parameter description.

[sourcery-ai]

Reviewer's Guide by Sourcery

This pull request updates the get_articles method in the omnivoreql.py file to accept an integer cursor instead of a string. This change ensures that the cursor parameter is now an integer, which aligns with the expected data type for pagination purposes. Additionally, the docstring has been updated to reflect this change and provide clearer information on the parameters.

File-Level Changes

Files	Changes
omnivoreql/omnivoreql.py	Updated the get_articles method to accept an integer cursor and revised the docstring for clarity.

---

Tips

• Trigger a new Sourcery review by commenting @sourcery-ai review on the pull request.
• You can change your review settings at any time by accessing your dashboard:
  • Enable or disable the Sourcery-generated pull request summary or reviewer's guide;
  • Change the review language;
• You can always contact us if you have any questions or feedback.

[sourcery-ai]

Hey @yazdipour - I've reviewed your changes and they look great!

Here's what I looked at during the review

• 🟡 General issues: 1 issue found
• 🟢 Security: all looks good
• 🟢 Testing: all looks good
• 🟡 Complexity: 1 issue found
• 🟢 Documentation: all looks good

---

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment to tell me if it was helpful.}

[sourcery-ai]

suggestion: Clarify the default value for the limit parameter.

The previous docstring mentioned that the default value for the limit parameter is 100. The updated docstring does not specify a default value. If the default is still 100, it would be helpful to retain that information.

Suggested change

	:param limit: The number of articles to return (default is 100).
	:param limit: The number of articles to return (default is 100, max can be 100).

[sourcery-ai]

issue (complexity): Consider maintaining the original type for cursor and keeping the documentation clear and precise.

The recent changes to the get_articles function have introduced some complexity and potential issues:

1. Type Change for cursor: Changing the type of cursor from str to int can lead to additional type conversions and potential bugs if other parts of the code or external systems expect cursor to be a string. This also impacts backward compatibility.

2. Documentation Clarity: The new docstring is less clear and introduces redundancy. The original docstring provided a detailed explanation of the parameters and was more informative.

To address these issues, consider maintaining the original type for cursor and keeping the documentation clear and precise. Here is a suggested revision:

def get_subscriptions(self):
    """
    Get the subscriptions of the current user.
    """
    return self.client.execute(self._get_query("GetSubscriptions"))

def get_articles(
    self,
    limit: int = None,
    cursor: str = None,
    format: str = "html",
    query: str = "in:inbox",
    include_content: bool = False,
):
    """
    Get articles for the current user. It is limited to first 100 articles by default. Use limit and cursor to fetch more.

    :param limit: The number of articles to return (default is 100).
    :param cursor: The cursor to use for pagination.
    :param format: The output format of the articles. Can be 'html' (default) or 'markdown'.
    :param query: The query to use for filtering articles. Example of query by date: 'in:inbox published:2024-03-01..*'. See https://docs.omnivore.app/using/search.html#filtering-by-save-publish-dates for more information.
    :param include_content: Whether to include the content of the articles.
    """
    return self.client.execute(
        self._get_query("Search"),
        variable_values={
            "first": limit,
            "after": cursor,
            "format": format,
            "query": query,
            "includeContent": include_content,
        },
    )

This revision maintains the original type for cursor and keeps the documentation clear and informative.