pyscaf

A python uv scaffolder - A tool to quickly initialize Python projects with complete and modern configuration.

Installation

The pyscaf module is available on PyPI and can be installed with pip:

pip install open-pyscaf

Or from the test repository:

pip install --index-url https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple open-pyscaf

Usage

Interactive Mode

The usage is simple and interactive:

pyscaf init --interactive project_name

This command initializes a project named project_name by asking you a few questions about the project nature.

Command Line Arguments

You can also provide arguments directly on the command line to avoid interactive questions:

pyscaf init --interactive test-versioning --versionning --remote-url tada.github --no-install

This allows you to:

• Set project name: test-versioning
• Enable versioning: --versionning
• Set remote URL: --remote-url tada.github
• Skip installation: --no-install

Features

In its current version, pyscaf automatically configures:

📦 Package Management with uv

• Complete uv configuration for package management
• Features similar to R's DESCRIPTION file
• Dependency management and publication

🎯 Code Quality with Ruff

• Configuration and installation of ruff for code normalization
• Default configuration included
• Automatic VS Code configuration:
  • Automatic import sorting
  • Line length control
  • Automatic linting and formatting

📓 Jupyter Environment

• Installation of jupyter and its dependencies
• Automatic file system structuring
• Ready-to-use configuration for data analysis

🔄 Git Versioning

• Automatic Git repository initialization
• Appropriate .gitignore file configuration
• Version tracking setup

🧪 Automated Testing

• pytest configuration for unit tests
• pytest-cov integration for code coverage
• Ready-to-use test structure

Development

This project is developed to simplify Python project creation with integrated best practices from the start.