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.1.tar.gz (16.0 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.1-py3-none-any.whl (18.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: uaft-0.2.1.tar.gz
  • Upload date:
  • Size: 16.0 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.1.tar.gz
Algorithm Hash digest
SHA256 b7bc7e72d6a53e9d4e1ac0db2d3157d000f4d4b9b24409ac09d5138a6b803713
MD5 7b17c144c07ac733882b748b873a7a26
BLAKE2b-256 c068c0deba4b7cadc4c57532bd425a9f825d1aa9b8b355eb8fa1ca19061582fc

See more details on using hashes here.

File details

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

File metadata

  • Download URL: uaft-0.2.1-py3-none-any.whl
  • Upload date:
  • Size: 18.5 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.1-py3-none-any.whl
Algorithm Hash digest
SHA256 bad6ea48a77e46254746638cf601cbb1f6ae507b26573e14879ff003bdf2b65d
MD5 af71a1d6faaf03b35481e959f3cfb241
BLAKE2b-256 5cd0e1eac3f76ec03b94cba5d3140a0f2e8e1de4b1c8efa5468cf24b6cd5fcff

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