Skip to content

Conversation

@fasteiner
Copy link
Owner

Summary

This PR introduces improvements to the development workflow and enhances project documentation and metadata.
Changes
🆕 Development Environment

Added a Visual Studio Code Dev Container configuration (.devcontainer/devcontainer.json) to simplify onboarding and ensure consistent development environments.

Added a setup script (.devcontainer/setup.sh) to automate:

    Poetry installation

    Dependency installation (including dev dependencies)

    Virtual environment activation

    Pre-commit hook installation

📄 Documentation Updates

Updated Contributing.md to recommend a more portable method for activating the Poetry virtual environment (eval $(poetry env activate)).

Enhanced README.md with new badges:

    PyPI version

    PyPI downloads

    GPL v3 license

🛠 Dependency Updates

Added the shell package (^1.0.1) to pyproject.toml to support improved shell scripting within the project.

Motivation

These changes aim to:

Streamline development environment setup across all contributors.

Improve onboarding experience for new developers.

Enhance project visibility on PyPI and GitHub.

Automate quality checks with pre-commit hooks.

@fasteiner fasteiner closed this Jun 13, 2025
@fasteiner fasteiner reopened this Jun 13, 2025
@fasteiner fasteiner merged commit e7de211 into main Jun 13, 2025
6 checks passed
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