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

docs: misc improved docs, added fetching raw events section #133

Merged
merged 14 commits into from
Jul 8, 2024

Conversation

brayo-pip
Copy link
Member

@brayo-pip brayo-pip commented Jul 2, 2024

More updates.


🚀 This description was created by Ellipsis for commit 50e3a3a

Summary:

Updated documentation and examples for querying and fetching raw events in ActivityWatch, including version updates and a new example script.

Key points:

  • Updated src/api/rest.rst to include a link to the Bucket REST API documentation.
  • Updated version and release information in src/conf.py to 0.13 and v0.13.1 respectively.
  • Modified src/examples/query_client.py to use client.client_hostname instead of client.hostname.
  • Added a new section on fetching raw events in src/examples/querying-data.rst.
  • Added a new example script src/examples/raw_events.py to demonstrate fetching and modifying raw events.

Generated with ❤️ by ellipsis.dev

Copy link

@ellipsis-dev ellipsis-dev bot left a comment

Choose a reason for hiding this comment

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

👍 Looks good to me! Reviewed everything up to 50e3a3a in 42 seconds

More details
  • Looked at 113 lines of code in 5 files
  • Skipped 0 files when reviewing.
  • Skipped posting 1 drafted comments based on config settings.
1. src/api/rest.rst:98
  • Draft comment:
    The link to the Bucket REST API is still marked as TODO. This should be updated or completed if the referenced section is ready.
`Bucket REST API <./rest.html#get-events>`_
  • Reason this comment was not posted:
    Confidence of 0% on close inspection, compared to threshold of 50%.

Workflow ID: wflow_r5iFLpNSSagxqHyu


You can customize Ellipsis with 👍 / 👎 feedback, review rules, user-specific overrides, quiet mode, and more.

src/importers.rst Outdated Show resolved Hide resolved
src/examples/raw_events.py Outdated Show resolved Hide resolved
@brayo-pip
Copy link
Member Author

@ErikBjare Anything else you think that I should add?

Copy link
Member

@ErikBjare ErikBjare left a comment

Choose a reason for hiding this comment

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

It's great! Sorry for the delay.

@ErikBjare ErikBjare merged commit c4fe5e0 into ActivityWatch:master Jul 8, 2024
1 check passed
@brayo-pip
Copy link
Member Author

No worries, thanks

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

Successfully merging this pull request may close these issues.

2 participants