dh-tech / undate-python

A Python library for working with fuzzy, partial, or otherwise uncertain dates
Apache License 2.0
8 stars 1 forks source link

Consolidate setup.cfg and pyproject.toml; drop tox; revamp sphinx docs #88

Closed rlskoeser closed 2 months ago

rlskoeser commented 4 months ago

ref #80

Summary by CodeRabbit

codecov[bot] commented 4 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 98.29%. Comparing base (00ede70) to head (0ddc395). Report is 7 commits behind head on develop.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## develop #88 +/- ## =========================================== - Coverage 99.00% 98.29% -0.72% =========================================== Files 6 7 +1 Lines 302 293 -9 =========================================== - Hits 299 288 -11 - Misses 3 5 +2 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

rlskoeser commented 2 months ago

@coderabbitai full review

coderabbitai[bot] commented 2 months ago
Actions performed Full review triggered.
coderabbitai[bot] commented 2 months ago

Walkthrough

The changes encompass updates to documentation files, contributor recognition, GitHub Actions workflows, and project configuration. Key modifications include the enhancement of contributor roles, updates to Python versioning and dependency management, restructuring of documentation for clarity, and a transition to modern packaging standards using hatchling. The overall aim is to improve project organization, contributor acknowledgment, and documentation accessibility.

Changes

Files Change Summary
.all-contributorsrc, CONTRIBUTORS.md Enhanced contributor roles and updated badge link for better representation of contributions.
.github/workflows/*.yml Updated Python version, caching mechanism, and testing commands for improved workflow efficiency.
CONTRIBUTING.md, README.md Simplified titles and improved clarity in navigation and instructions for contributors.
DEVELOPER_NOTES.md, docs/*.md Introduced inclusion directives for modular documentation and improved clarity in developer notes.
pyproject.toml Transitioned to hatchling, added project metadata, dependencies, and optional dependencies.
docs/conf.py, docs/index.rst Updated project metadata, Sphinx configuration, and restructured the table of contents.
docs/_templates/sidebar_dhtech.html Added a "powered by" section to enhance branding in documentation.
docs/_static/custom.css Improved sidebar styling for better visual presentation.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Docs
    participant Contributors
    participant CI/CD
    participant Project

    User->>Docs: Access documentation
    Docs->>Contributors: Fetch contributor info
    Contributors->>Docs: Return updated contributor roles
    Docs->>User: Display enhanced contributor section

    User->>Project: Submit contribution
    Project->>CI/CD: Trigger workflow
    CI/CD->>Project: Run tests and build
    Project->>User: Acknowledge contribution

🐰 "In the garden, changes bloom,
Roles for all, dispelling gloom.
Python's new, the docs align,
Contributions now brightly shine.
Hopping forth, we celebrate,
Together, we create our fate!" πŸ‡


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `Generate unit testing code for this file.` - `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. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - 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 generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` - `@coderabbitai help me debug CodeRabbit configuration file.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (Invoked using PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. ### 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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` ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.