Appiumfw 🚀

A lightweight, POM structured test automation framework for Python + Appium, including:

📦 Project scaffolding with afw init

⟳ Test suite, test case, feature, and step generation using Jinja2 templating

▶️ Runner for executing feature (.feature), YAML suite, or .py test case files

🌐 REST API server (afw serve) to list and schedule test suites

🔗 API client module (appiumfw.api_client) for programmatic integration

⚙️ Typer-powered CLI for all commands

🛡️ Hooks/listener system, dotenv support, jinja templating

🔧 Features

afw setup — setup all mobile dependencies: node js, appium, uiAutomatior2

afw init — bootstrap a complete appiumfw project scaffold

afw create-testsuite — generate boilerplate YAML test suite & .py for its test suite hook

afw create-testsuite-collection — generate boilerplate YAML test suite collection

afw create-testcase — generate a .py test case stub

afw create-listener — generate a test listener

afw create-feature — generate a .feature file

afw implement-feature — autogenerate step definitions from your .feature

afw run — run one of .feature, .yml, or .py test scripts

afw serve [--port ] — expose a REST API to list, run, and schedule test suites

✅ Installation

pip install appiumfw

Or locally:

git clone https://github.com/badrusalam11/appiumfw.git cd appiumfw pip install -e .

🚀 Quick Start

1. Setup mobile project afw setup

2. Scaffold a new project

afw init myproject cd myproject

3. Create testsuite/feature/case

afw create-testsuite login afw create-feature login afw implement-feature login

4. Add test logic in testcases/, steps/, etc.

5. Run tests

afw run features/login.feature # via behave afw run testsuites/login.yml # via runner

after that, choose the mobile device, or set it directly in deviceName at settings/appium.properties

🌐 API Testing Example

You can use the same ApiClient to test any public free REST API, for example JSONPlaceholder:

from appiumfw.api_client import ApiClient

initialize client for JSONPlaceholder

client = ApiClient( base_url="https://jsonplaceholder.typicode.com", default_headers={"Accept": "application/json"} )

GET a list of posts

response = client.get("/posts") assert response.status_code == 200 posts = response.json() assert isinstance(posts, list) print(f"Retrieved {len(posts)} posts")

GET a single post

response = client.get("/posts/1") assert response.status_code == 200 post = response.json() assert post.get("id") == 1 print(f"Post title: {post.get('title')}")

POST a new post (will return a mock id)

new_post = { "title": "foo", "body": "bar", "userId": 1 } response = client.post("/posts", json=new_post) assert response.status_code == 201 created = response.json() assert created.get("id") is not None print(f"Created post ID: {created.get('id')}")

🛠️ Configuration

Use a .env in your project root to customize:

APP_PORT=5006 SERVER_URL=http://localhost:5006

💡 Why use appiumfw?

🧠 Inspired by Katalon, but for Python developers

🌟 Supports feature files + step generation + scheduling

🚀 Design for both CLI use and API integration

🧹 Expandable via listeners/hooks, Config, MobileFactory, etc.

🤝 Contributing

PRs are welcome! Please ensure:

Code is well-documented and follows PEP8

Templates & CLI updated accordingly

README.md and tests updated

Use Black, Flake8, isort (recommended)

📜 License

MIT — see LICENSE for details.

📨 Contact

Built & maintained by Muhamad Badru Salam — QA Automation Engineer (SDET)

Github: badrusalam11

LinkedIn: Muhamad Badru Salam

Email: muhamadbadrusalam760@gmail.com