orbs-cli 0.1.0__tar.gz

orbs_cli-0.1.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2025 [Muhamad Badru Salam of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

orbs_cli-0.1.0/MANIFEST.in

@@ -0,0 +1,2 @@
+recursive-include orbs/templates *
+recursive-include orbs/spy/js *.js

orbs_cli-0.1.0/PKG-INFO

@@ -0,0 +1,226 @@
+Metadata-Version: 2.4
+Name: orbs-cli
+Version: 0.1.0
+Summary: Orbs - an automation framework for Web, Mobile (Appium), and API testing designed to grow with your team
+Author-email: Muhamad Badru Salam <badrusalam760@gmail.com>
+License: Apache-2.0
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: typer[all]
+Requires-Dist: flask
+Requires-Dist: pyyaml
+Requires-Dist: apscheduler
+Requires-Dist: jinja2
+Requires-Dist: requests
+Requires-Dist: python-dotenv
+Requires-Dist: Appium-Python-Client
+Requires-Dist: selenium
+Requires-Dist: behave
+Requires-Dist: reportlab
+Requires-Dist: InquirerPy
+Dynamic: license-file
+
+<p align="center">
+  <img src="assets/orbs.png" width="120" />
+</p>
+
+<h1 align="center">Orbs</h1>
+
+<p align="center">
+  Automation framework that grows with your team
+</p>
+
+---
+
+## What is Orbs?
+
+**Orbs** is an automation framework for **Web, Mobile (Appium), and API testing** designed to **grow with your team**.
+
+Orbs supports different levels of automation maturity:
+
+* Junior QA engineers can start with visual tools, record-and-playback, reusable keywords, and Studio-based workflows
+* Senior engineers can work directly with code, CLI, and CI/CD pipelines without restrictions or license lock-in
+
+Both approaches share the same execution engine and project structure, allowing teams to evolve their automation practices **without rewriting tests or migrating frameworks**.
+
+---
+
+## Philosophy
+
+### 1. Tests are software, not scripts
+
+Automation code should be designed, structured, reviewed, and evolved like production code — not copied scripts glued together over time.
+
+### 2. Explicit is better than implicit
+
+If something runs, it should be obvious:
+
+* what is executed
+* from where
+* with which configuration
+
+No silent defaults. No hidden behavior.
+
+### 3. Structure before scale
+
+Orbs enforces structure early so teams don’t pay technical debt later. Scaling automation should feel predictable, not painful.
+
+### 4. One core, many interfaces
+
+The same execution engine can be accessed via:
+
+* CLI
+* REST API
+* Orbs Studio (GUI)
+
+Different entry points, same behavior.
+
+### 5. Tooling should assist, not hide reality
+
+Generators, runners, and spy tools exist to accelerate work — not to obscure how automation actually works.
+
+---
+
+## Table of Contents
+
+* [Core Capabilities](#core-capabilities)
+* [Quick Start](#quick-start)
+* [CLI Overview](#cli-overview)
+* [Spy](#spy)
+* [Project Structure](#project-structure)
+* [Configuration](#configuration)
+* [Documentation](#documentation)
+* [Contributing](#contributing)
+* [License](#license)
+
+---
+
+## Core Capabilities
+
+* 📦 Project scaffolding with `orbs init`
+* 🧱 Clear project structure for large test suites
+* ⟳ Test suite, test case, feature, and step generation
+* ▶️ Unified runner for `.feature`, `.yml`, and `.py`
+* 🌐 REST API server for listing and scheduling executions
+* 🕵️ Web & Mobile Spy for element inspection
+* ⚙️ Typer-powered CLI
+* 🧩 Extensible hooks and listeners
+
+---
+
+## Quick Start
+
+```bash
+pip install orbs-cli
+
+orbs setup android
+orbs init myproject
+cd myproject
+
+orbs create-feature login
+orbs implement-feature login
+orbs run features/login.feature
+```
+
+---
+
+## CLI Overview
+
+```bash
+orbs setup android
+orbs init <project>
+orbs create-testsuite <name>
+orbs create-testcase <name>
+orbs create-feature <name>
+orbs implement-feature <name>
+orbs run <target>
+orbs serve [--port <port>]
+orbs spy
+```
+
+---
+
+## Spy
+
+Orbs provides an interactive **Web & Mobile Spy**, similar to Katalon's Object Spy, for inspecting elements and capturing locators.
+
+```bash
+orbs spy --web --url=https://example.com
+orbs spy --mobile
+```
+
+📖 Full Spy documentation: `docs/spy.md`
+
+---
+
+## Project Structure
+
+```text
+myproject/
+├── features/
+├── steps/
+├── testcases/
+├── testsuites/
+├── listeners/
+├── settings/
+└── .env
+```
+
+---
+
+## Configuration
+
+Environment variables and properties are defined explicitly using `.env` and `settings/*.properties`.
+
+```env
+APP_PORT=5006
+SERVER_URL=http://localhost:5006
+```
+
+📖 Full configuration guide: `docs/configuration.md`
+
+---
+
+## Documentation
+
+Detailed documentation is available under the `docs/` directory:
+
+* [Philosophy & Concepts](docs/philosophy.md) - Framework principles and maturity levels
+* [CLI Reference](docs/cli-reference.md) - Complete command documentation
+* [Web Testing](docs/web-testing.md) - Browser automation guide
+* [Mobile Testing](docs/mobile-testing.md) - Android testing with Appium
+* [API Testing](docs/api-testing.md) - REST API testing guide
+* [Spy Tool](docs/spy.md) - Element inspection and capture
+* [Architecture](docs/architecture.md) - Technical design and patterns
+
+**Start here:** [docs/philosophy.md](docs/philosophy.md)
+
+---
+
+## Contributing
+
+Contributions are welcome.
+
+Please ensure:
+
+* Templates and CLI commands are updated
+* Documentation reflects behavior changes
+
+---
+
+## License
+
+Licensed under the Apache License, Version 2.0.  
+See the [LICENSE](https://github.com/badrusalam11/orbs-cli/blob/main/LICENSE) file for details.
+
+
+---
+
+## Contact
+
+Built & maintained by **Muhamad Badru Salam** - QA Engineer (SDET)
+
+* GitHub: [https://github.com/badrusalam11](https://github.com/badrusalam11)
+* LinkedIn: [https://www.linkedin.com/in/muhamad-badru-salam/](https://www.linkedin.com/in/muhamad-badru-salam/)
+* Email: [muhamadbadrusalam760@gmail.com](mailto:muhamadbadrusalam760@gmail.com)

orbs_cli-0.1.0/README.md

@@ -0,0 +1,203 @@
+<p align="center">
+  <img src="assets/orbs.png" width="120" />
+</p>
+
+<h1 align="center">Orbs</h1>
+
+<p align="center">
+  Automation framework that grows with your team
+</p>
+
+---
+
+## What is Orbs?
+
+**Orbs** is an automation framework for **Web, Mobile (Appium), and API testing** designed to **grow with your team**.
+
+Orbs supports different levels of automation maturity:
+
+* Junior QA engineers can start with visual tools, record-and-playback, reusable keywords, and Studio-based workflows
+* Senior engineers can work directly with code, CLI, and CI/CD pipelines without restrictions or license lock-in
+
+Both approaches share the same execution engine and project structure, allowing teams to evolve their automation practices **without rewriting tests or migrating frameworks**.
+
+---
+
+## Philosophy
+
+### 1. Tests are software, not scripts
+
+Automation code should be designed, structured, reviewed, and evolved like production code — not copied scripts glued together over time.
+
+### 2. Explicit is better than implicit
+
+If something runs, it should be obvious:
+
+* what is executed
+* from where
+* with which configuration
+
+No silent defaults. No hidden behavior.
+
+### 3. Structure before scale
+
+Orbs enforces structure early so teams don’t pay technical debt later. Scaling automation should feel predictable, not painful.
+
+### 4. One core, many interfaces
+
+The same execution engine can be accessed via:
+
+* CLI
+* REST API
+* Orbs Studio (GUI)
+
+Different entry points, same behavior.
+
+### 5. Tooling should assist, not hide reality
+
+Generators, runners, and spy tools exist to accelerate work — not to obscure how automation actually works.
+
+---
+
+## Table of Contents
+
+* [Core Capabilities](#core-capabilities)
+* [Quick Start](#quick-start)
+* [CLI Overview](#cli-overview)
+* [Spy](#spy)
+* [Project Structure](#project-structure)
+* [Configuration](#configuration)
+* [Documentation](#documentation)
+* [Contributing](#contributing)
+* [License](#license)
+
+---
+
+## Core Capabilities
+
+* 📦 Project scaffolding with `orbs init`
+* 🧱 Clear project structure for large test suites
+* ⟳ Test suite, test case, feature, and step generation
+* ▶️ Unified runner for `.feature`, `.yml`, and `.py`
+* 🌐 REST API server for listing and scheduling executions
+* 🕵️ Web & Mobile Spy for element inspection
+* ⚙️ Typer-powered CLI
+* 🧩 Extensible hooks and listeners
+
+---
+
+## Quick Start
+
+```bash
+pip install orbs-cli
+
+orbs setup android
+orbs init myproject
+cd myproject
+
+orbs create-feature login
+orbs implement-feature login
+orbs run features/login.feature
+```
+
+---
+
+## CLI Overview
+
+```bash
+orbs setup android
+orbs init <project>
+orbs create-testsuite <name>
+orbs create-testcase <name>
+orbs create-feature <name>
+orbs implement-feature <name>
+orbs run <target>
+orbs serve [--port <port>]
+orbs spy
+```
+
+---
+
+## Spy
+
+Orbs provides an interactive **Web & Mobile Spy**, similar to Katalon's Object Spy, for inspecting elements and capturing locators.
+
+```bash
+orbs spy --web --url=https://example.com
+orbs spy --mobile
+```
+
+📖 Full Spy documentation: `docs/spy.md`
+
+---
+
+## Project Structure
+
+```text
+myproject/
+├── features/
+├── steps/
+├── testcases/
+├── testsuites/
+├── listeners/
+├── settings/
+└── .env
+```
+
+---
+
+## Configuration
+
+Environment variables and properties are defined explicitly using `.env` and `settings/*.properties`.
+
+```env
+APP_PORT=5006
+SERVER_URL=http://localhost:5006
+```
+
+📖 Full configuration guide: `docs/configuration.md`
+
+---
+
+## Documentation
+
+Detailed documentation is available under the `docs/` directory:
+
+* [Philosophy & Concepts](docs/philosophy.md) - Framework principles and maturity levels
+* [CLI Reference](docs/cli-reference.md) - Complete command documentation
+* [Web Testing](docs/web-testing.md) - Browser automation guide
+* [Mobile Testing](docs/mobile-testing.md) - Android testing with Appium
+* [API Testing](docs/api-testing.md) - REST API testing guide
+* [Spy Tool](docs/spy.md) - Element inspection and capture
+* [Architecture](docs/architecture.md) - Technical design and patterns
+
+**Start here:** [docs/philosophy.md](docs/philosophy.md)
+
+---
+
+## Contributing
+
+Contributions are welcome.
+
+Please ensure:
+
+* Templates and CLI commands are updated
+* Documentation reflects behavior changes
+
+---
+
+## License
+
+Licensed under the Apache License, Version 2.0.  
+See the [LICENSE](https://github.com/badrusalam11/orbs-cli/blob/main/LICENSE) file for details.
+
+
+---
+
+## Contact
+
+Built & maintained by **Muhamad Badru Salam** - QA Engineer (SDET)
+
+* GitHub: [https://github.com/badrusalam11](https://github.com/badrusalam11)
+* LinkedIn: [https://www.linkedin.com/in/muhamad-badru-salam/](https://www.linkedin.com/in/muhamad-badru-salam/)
+* Email: [muhamadbadrusalam760@gmail.com](mailto:muhamadbadrusalam760@gmail.com)