feat: Convert to src layout with poetry and setuptools-scm and pixi

[jakevc]

Summary by CodeRabbit

• New Features

  • Improved package metadata handling with a fallback mechanism for version information.

• Bug Fixes

  • Enhanced compatibility for file copying operations across different environments.

• Refactor

  • Migrated package source files to a new directory structure.
  • Updated package initialization and version management approach.
  • Streamlined and modernized packaging and build configuration.
  • Removed legacy version management tooling and related files.
  • Replaced the license with the MIT License for simpler permissive terms.

• Chores

  • Simplified and modernized continuous integration workflows using Pixi.
  • Updated ignored and included files for version control and distribution.

• Tests

  • Updated test scripts to deploy from the main branch instead of a specific tag.

resolves #87

[coderabbitai[bot]]

[!WARNING]

Rate limit exceeded

@jakevc has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 1 minutes and 17 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between 5e7c460a5edc36f47678ea0e94f985a1b0021518 and da9e5ce5115628b81147a7df1d790e9c8eac6523.

⛔ Files ignored due to path filters (1)

• pyproject.toml is excluded by !pyproject.toml

📒 Files selected for processing (1)

• .github/workflows/release-please.yml (1 hunks)

📝 Walkthrough

Walkthrough

This change restructures the project to relocate the snakedeploy package under a new src directory, removes Versioneer-based version management, and deletes legacy packaging scripts and configuration files. The GitHub Actions workflows are refactored to use Pixi for environment management and modern Python build tools. The import logic for copy_tree is made more robust, and test scripts are updated for branch-based deployment.

Changes

File(s) / Path(s)	Change Summary
.gitattributes, .gitignore	Updated paths to reflect relocation of _version.py to src/snakedeploy/_version.py and ignore it in version control.
MANIFEST.in	Changed to explicitly include pyproject.toml, use graft src, and remove explicit includes for versioneer and old source layout.
.github/workflows/main.yml, .github/workflows/release-please.yml	Refactored workflows to use Pixi for environment and tool management; updated build and test steps to modern standards.
setup.cfg, setup.py, versioneer.py	Deleted legacy packaging, configuration, and version management scripts related to setuptools and Versioneer.
snakedeploy/__init__.py, snakedeploy/_version.py	Removed legacy package initialization and Versioneer-based version logic.
src/snakedeploy/__init__.py	Added new package initializer with metadata and fallback version assignment.
src/snakedeploy/providers.py	Improved import logic for copy_tree to support multiple possible module locations.
tests/test_client.sh	Updated test to deploy from the main branch instead of a specific tag.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant GitHub Actions
    participant Pixi
    participant Python Build Tools

    User->>GitHub Actions: Push code or open PR
    GitHub Actions->>Pixi: Setup environment (quality/testing)
    GitHub Actions->>Pixi: Install dependencies
    GitHub Actions->>Pixi: Run code quality checks/tests
    GitHub Actions->>Python Build Tools: Build and check package (release workflow)
    GitHub Actions->>PyPI: Publish package (if release)

sequenceDiagram
    participant snakedeploy.__init__.py
    participant _version module

    snakedeploy.__init__.py->>_version module: Try to import __version__
    alt Import succeeds
        snakedeploy.__init__.py->>snakedeploy.__init__.py: Set __version__ from _version
    else Import fails
        snakedeploy.__init__.py->>snakedeploy.__init__.py: Set __version__ = "0.0.0"
    end
    snakedeploy.__init__.py->>snakedeploy.__init__.py: Assert __version__ is set

Assessment against linked issues

Objective	Addressed	Explanation
Move to poetry/pixi environment management and replace Conda setups (#87)	✅	GitHub workflows now use prefix-dev/setup-pixi for environment setup and command execution.
Remove dependency on distutils to avoid import errors in Python 3.13 (#87)	✅	copy_tree import modified with fallback to shutil.copytree to avoid distutils import error.
Implement dynamic versioning compatible with modern packaging (#87)	✅	Removed Versioneer and legacy versioning; new version import with fallback in src/snakedeploy/__init__.py.

---

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

• 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.
  • Explain this complex logic.
  • 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 explain this code block.
  • @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 explain its main purpose.
  • @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.

Support

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

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 generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this 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.

[johanneskoester]

I've now moved this entirely to pixi.