Skip to content

Add datetime and azure utilities#78

Merged
pateash merged 22 commits into
mainfrom
codex/close-github-issue-#68
Aug 12, 2025
Merged

Add datetime and azure utilities#78
pateash merged 22 commits into
mainfrom
codex/close-github-issue-#68

Conversation

@pateash

@pateash pateash commented Jun 17, 2025

Copy link
Copy Markdown
Collaborator

Closes #68 #80

Summary

  • add new dt command group for timezone utilities
  • provide timezone conversion logic
  • document new commands
  • test new CLI functionality

Testing

  • pytest -k "not net_speed" -q

https://chatgpt.com/codex/tasks/task_e_68504a607a408327a648ffce3bd36fa6

Summary by CodeRabbit

  • Documentation
    • Added comprehensive documentation for the Datetime commands (dt, now, convert_time), including a master/index page and usage examples.
    • Added a hidden Datetime section to the commands index for organization.
    • Added initial Azure command documentation and an index entry to surface Azure commands.

@coderabbitai

coderabbitai Bot commented Jun 17, 2025

Copy link
Copy Markdown
Contributor

Important

Review skipped

Review was skipped due to path filters

⛔ Files ignored due to path filters (7)
  • dev/PUBLISHING.md is excluded by none and included by none
  • src/hckr/__about__.py is excluded by none and included by none
  • src/hckr/cli/azure.py is excluded by none and included by none
  • src/hckr/utils/AzureUtils.py is excluded by none and included by none
  • src/hckr/utils/TimeUtils.py is excluded by none and included by none
  • tests/cli/test_cli.py is excluded by none and included by none
  • tests/utils/test_azure_utils.py is excluded by none and included by none

CodeRabbit blocks several paths by default. You can override this behavior by explicitly including those paths in the path filters. For example, including **/dist/** will override the default block on the dist directory, by removing the pattern from both the lists.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

Added new Sphinx documentation pages for datetime and Azure command groups: a detailed hckr dt reference, a datetime commands index, an Azure command page, and updated the main commands index to include hidden toctrees for Datetime and Azure.

Changes

Cohort / File(s) Change Summary
Datetime docs
docs/source/commands/dt/dt.rst, docs/source/commands/dt/index.rst
Added Sphinx documentation for the hckr dt command, its now and convert_time subcommands, usage examples, timezone notes, and a section index referencing dt.
Azure docs scaffold
docs/source/commands/azure/azure.rst, docs/source/commands/azure/index.rst
Added Sphinx-click directive and index page scaffolding for the hckr azure command group (documentation-only).
Commands index update
docs/source/commands/index.rst
Appended hidden toctree entries for "Datetime" and "Azure" sections linking to the new indexes.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Assessment against linked issues

Objective (issue) Addressed Explanation
Add/Document datetime utilities with timezone support [#68] This PR adds documentation for hckr dt commands (now/convert_time) but contains no implementation changes; unclear if underlying utilities exist or were added elsewhere.

Poem

"I hop through docs with eager paws,
I map the clocks and note the laws.
Timezones listed, examples bright,
A tidy guide by lantern light.
Hooray — the dt pages take flight! 🐇"

✨ Finishing Touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch codex/close-github-issue-#68

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR/Issue comments)

Type @coderabbitai help to get the list of available commands.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Status, Documentation and Community

  • Visit our Status Page to check the current availability of CodeRabbit.
  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@github-actions github-actions Bot added documentation Improvements or additions to documentation enhancement New feature or request tests Changes to test labels Jun 17, 2025

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🧹 Nitpick comments (4)
docs/source/commands/index.rst (1)

81-87: Maintain alphabetical ordering for consistency.

The new "Datetime" section is appended after "Info", which breaks the alphabetical sequence of command categories. Consider repositioning it (e.g., after "Database" and before "Env") to keep the listing consistent.

docs/source/commands/dt/index.rst (2)

1-4: Remove generic Sphinx boilerplate.

The auto-generated sphinx-quickstart header adds noise. You can safely remove or replace it with a concise module/doc description.


16-17: Align toctree options with other command index files.

For consistency, add :maxdepth: 2 and :hidden: to the toctree directive, mirroring other command group indices. For example:

.. toctree::
   :maxdepth: 2
   :hidden:

   dt
docs/source/commands/dt/dt.rst (1)

1-4: Remove auto-generated header comments.

The sphinx-quickstart boilerplate can be removed; it doesn't add value to this command doc.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting

📥 Commits

Reviewing files that changed from the base of the PR and between 455b693 and 243698a.

⛔ Files ignored due to path filters (5)
  • src/hckr/cli/__init__.py is excluded by none and included by none
  • src/hckr/cli/dt.py is excluded by none and included by none
  • src/hckr/utils/TimeUtils.py is excluded by none and included by none
  • tests/cli/test_cli.py is excluded by none and included by none
  • tests/cli/test_dt.py is excluded by none and included by none
📒 Files selected for processing (3)
  • docs/source/commands/dt/dt.rst (1 hunks)
  • docs/source/commands/dt/index.rst (1 hunks)
  • docs/source/commands/index.rst (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (5)
  • GitHub Check: build-and-test (ubuntu-latest, 3.8)
  • GitHub Check: build-and-test (ubuntu-latest, 3.12)
  • GitHub Check: build-and-test (ubuntu-latest, 3.11)
  • GitHub Check: build-and-test (ubuntu-latest, 3.10)
  • GitHub Check: build-and-test (ubuntu-latest, 3.9)

Comment thread docs/source/commands/dt/dt.rst Outdated
Comment on lines +6 to +8
.. click:: hckr.cli.dt:dt
:prog: hckr dt
:nested: full

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🛠️ Refactor suggestion

Add a title for the hckr dt command.

Include a top-level heading to introduce this command (e.g., hckr dt underlined with =) above the click directive for better readability.

Apply this diff:

+ hckr dt
+ ========

 .. click:: hckr.cli.dt:dt
    :prog: hckr dt
    :nested: full
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
.. click:: hckr.cli.dt:dt
:prog: hckr dt
:nested: full
hckr dt
========
.. click:: hckr.cli.dt:dt
:prog: hckr dt
:nested: full
🤖 Prompt for AI Agents
In docs/source/commands/dt/dt.rst around lines 6 to 8, add a top-level heading
for the `hckr dt` command by inserting a line with `hckr dt` followed by an
underline of equal signs (`=`) above the existing click directive. This will
improve readability by clearly introducing the command section.

@github-actions github-actions Bot added the release This will lead to a new release label Aug 12, 2025
@pateash pateash changed the title Add datetime utilities Add datetime and azure utilities Aug 12, 2025
@pateash pateash merged commit bd594ed into main Aug 12, 2025
8 of 9 checks passed
@pateash pateash deleted the codex/close-github-issue-#68 branch August 12, 2025 12:26
@github-project-automation github-project-automation Bot moved this from Todo to Done in hckr's Board Aug 12, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

codex documentation Improvements or additions to documentation enhancement New feature or request project-config release This will lead to a new release tests Changes to test

Projects

None yet

Development

Successfully merging this pull request may close these issues.

datetime utilities with different timezones

1 participant