feature: big refactor to overhaul the structure and configurations

[jjjermiah]

Summary by CodeRabbit

• New Features

  • Enhanced syntax highlighting for specific file types in GitHub.
  • Introduced automated workflow for updating lockfiles for the Pixi package.
  • Added multiple badges to the README for project metrics.
  • New configuration files for coverage reporting, package management, and semantic versioning.
  • Introduced a new test function to validate the output of the main function.

• Bug Fixes

  • Updated import paths for better module accessibility.

• Chores

  • Streamlined project initialization instructions and updated Python version settings.

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

The changes in this pull request involve updates to various configuration files and templates within a Python package project. Key modifications include the addition of new entries in the .gitattributes file for syntax highlighting, the introduction of a GitHub Actions workflow for automating lockfile updates, and the creation of new configuration files for coverage, Hatch, mypy, pytest, semantic release, and Ruff. Additionally, several existing files were modified to improve import statements, enhance README badges, and streamline user instructions in the project setup.

Changes

File Path	Change Summary
.gitattributes	Added language associations for .py.jinja, .toml.jinja, .md.jinja, and .yaml.jinja.
.github/workflows/updates.yaml	Introduced a new GitHub Actions workflow for updating Pixi lockfiles.
.gitignore	Removed PyCharm section; added entries to ignore coverage reports, recipe files, and cache files.
README.md.jinja	Added multiple badge links for project metrics and status.
config/coverage.toml.jinja	New configuration for coverage reporting, specifying source directories and excluding certain files.
config/hatch.toml.jinja	New configuration for the Hatch build system, defining build settings and targets.
config/mypy.ini.jinja	New configuration for mypy, specifying source directories and enabling various type checks.
config/pytest.ini.jinja	New configuration for pytest, specifying test execution settings and coverage report formats.
config/releaserc.toml.jinja	New configuration for semantic release, defining versioning and release process settings.
config/ruff.toml.jinja	New configuration for Ruff linter, specifying linting rules and settings.
src/{{package_name}}/__init__.py.jinja	Updated import statement from relative to absolute import for main.
src/{{package_name}}/main.py.jinja	Modified import for print from rich to rprint.
tests/test_say_hello.py.jinja	Added new test function for main and updated import statements.
copier-settings.yml	Added conditional git initialization task and updated post-creation instructions.
copier.yml	Updated default Python version and modified environment options.
includes/template-license.jinja	Modified license names in the template to be output as strings.
PACKAGE_TEMPLATE/hatch.toml.jinja	Removed the file, eliminating build and versioning configurations.

Poem

In the fields where code does play,
New paths emerge, bright as day.
With badges shining, workflows align,
Our project grows, oh how divine!
From tests to coverage, all in tune,
A rabbit hops, beneath the moon! 🐰✨

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between e1bc096 and b690fea.

📒 Files selected for processing (20)

• .gitattributes (1 hunks)
• PACKAGE_TEMPLATE/.github/workflows/updates.yaml (1 hunks)
• PACKAGE_TEMPLATE/.gitignore (0 hunks)
• PACKAGE_TEMPLATE/README.md.jinja (1 hunks)
• PACKAGE_TEMPLATE/config/coverage.toml.jinja (1 hunks)
• PACKAGE_TEMPLATE/config/hatch.toml.jinja (1 hunks)
• PACKAGE_TEMPLATE/config/mypy.ini.jinja (1 hunks)
• PACKAGE_TEMPLATE/config/pytest.ini.jinja (1 hunks)
• PACKAGE_TEMPLATE/config/releaserc.toml.jinja (1 hunks)
• PACKAGE_TEMPLATE/config/ruff.toml.jinja (1 hunks)
• PACKAGE_TEMPLATE/hatch.toml.jinja (0 hunks)
• PACKAGE_TEMPLATE/pixi.toml.jinja (1 hunks)
• PACKAGE_TEMPLATE/pyproject.toml.jinja (2 hunks)
• PACKAGE_TEMPLATE/ruff.toml.jinja (0 hunks)
• PACKAGE_TEMPLATE/src/{{package_name}}/__init__.py.jinja (1 hunks)
• PACKAGE_TEMPLATE/src/{{package_name}}/main.py.jinja (2 hunks)
• PACKAGE_TEMPLATE/tests/test_say_hello.py.jinja (1 hunks)
• copier-settings.yml (2 hunks)
• copier.yml (2 hunks)
• includes/template-license.jinja (1 hunks)

---

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
• Mastodon
• Reddit
• LinkedIn

🪧 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.
  • 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 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 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 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 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.