Skip to main content

Universal Automation Framework Tool

Project description

UAFT - Universal Automation Framework Tool

The "Make" for the modern era. A lightweight, configuration-driven, and extensible automation framework designed to standardize workflows across any project.

🚀 Features

  • Universal Configuration: Define project-specific rules in uaft.json. No more hardcoded scripts.
  • Plugin Architecture: Extend functionality with any script (Bash, Python, etc.) via uaft plugin.
  • Smart Defaults: Built-in support for fix (formatting), cleanup (artifacts), and test (execution & tracking).
  • Zero Dependencies: Pure Python standard library. No pip install heavy deps required.

📦 Installation

pip install uaft

UAFT has zero dependencies. It installs instantly and runs anywhere Python 3.8+ is available.

⚡ Quick Start

  1. Initialize a new project:

    cd my-project
    uaft init
    

    This creates a uaft.json file with default settings.

  2. Run standard commands:

    uaft fix        # Run configured formatters (e.g., black, isort, prettier)
    uaft cleanup    # Remove configured artifacts (e.g., __pycache__, node_modules)
    uaft test       # Run tests
    

🔌 Plugin System

UAFT is designed to be extensible. You can install external scripts as first-class commands.

# Install a plugin (can be a local file or URL in the future)
uaft plugin install ./scripts/my-custom-tool.sh

# List installed plugins
uaft plugin list

# Run the plugin
uaft my-custom-tool arg1 arg2

⚙️ Configuration (uaft.json)

Control everything via uaft.json.

{
  "project": "my-awesome-project",
  "fix": [
    "black src tests",
    "isort src tests"
  ],
  "cleanup": [
    "**/*.pyc",
    "**/__pycache__",
    "dist/",
    "build/"
  ],
  "test": {
    "command": "pytest",
    "args": ["-v"]
  }
}

🛠️ Core Commands

Command Description
uaft init Generate a uaft.json configuration file.
uaft fix Run code formatters and fixers defined in config.
uaft cleanup Clean up build artifacts and temporary files.
uaft test Run the test suite. Use --track to log results.
uaft plugin Manage external plugins (install, list).
uaft hooks Manage git hooks.

🤝 Contributing

Contributions are welcome! Please see CONTRIBUTING.md for details.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

uaft-0.2.0.tar.gz (13.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

uaft-0.2.0-py3-none-any.whl (14.9 kB view details)

Uploaded Python 3

File details

Details for the file uaft-0.2.0.tar.gz.

File metadata

  • Download URL: uaft-0.2.0.tar.gz
  • Upload date:
  • Size: 13.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.5

File hashes

Hashes for uaft-0.2.0.tar.gz
Algorithm Hash digest
SHA256 396e19efa4577db0195d627e2ef885753c1e1f110349ddedae2d40c714b31a11
MD5 b788a5d920a0d47213bb7521ccf2d034
BLAKE2b-256 1a72b5f83928a3589c42da2f62397a4e4b75f1e98de22dfce671019efbfdb752

See more details on using hashes here.

File details

Details for the file uaft-0.2.0-py3-none-any.whl.

File metadata

  • Download URL: uaft-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 14.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.5

File hashes

Hashes for uaft-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 15918bcdeb65a61e7b8f91df1817e66656130e7c0e63995fd7961f219222abfa
MD5 5bf7a31fa531e1699362b9b8e64cca10
BLAKE2b-256 ad3a1b02705f46285eb10618e69808781d991e1ed4887615356e3067ed1d48e4

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page