diff --git a/README.md b/README.md index 9e7d925..efc6ec0 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,23 @@ -# :llama: SQUAPE - Squish API Python Extension +![Squish - version](https://img.shields.io/badge/Squish-v6.7.0+-brightgreen) +![PyPI - Python Version](https://img.shields.io/pypi/pyversions/squape) +![PyPI - License](https://img.shields.io/pypi/l/squape) +# SQUAPE - Squish API Python Extension Python package that extends Squish Python API. It provides tools for everyday automated test cases development. ### Requirements To enjoy all the features of the SQUAPE package, you have to use it with Squish version 6.7.0 or newer. ### Installation -The packages are available on the Python Package Index (PyPI). -- The `squape-report` package includes methods that enrich Squish reporting and verifying capabilities - -You can install them via `pip` with the following commands: +The package is available on the Python Package Index (PyPI). +You can install it via `pip` with the following commands: ```sh -pip install squape-report +pip install squape ``` +### Content +The package consists of several modules: +- report - adds features to enhance the reporting and verification capabilities of Squish. + ## Contribution The package is created and maintained by [Cyber Alpaca](https://cyberalpaca.com/) Pull requests for any issues are welcome. diff --git a/squape-report/pyproject.toml b/pyproject.toml similarity index 94% rename from squape-report/pyproject.toml rename to pyproject.toml index 53a581f..343a640 100644 --- a/squape-report/pyproject.toml +++ b/pyproject.toml @@ -7,10 +7,10 @@ build-backend = "setuptools.build_meta" [tool.setuptools.packages.find] where = ["."] include = ["squape"] -namespaces = true +namespaces = false [project] -name = "squape-report" +name = "squape" version = "0.1.0" authors = [ { name="Cyber Alpaca", email="contact@cyberalpaca.com" }, diff --git a/squape-report/LICENSE b/squape-report/LICENSE deleted file mode 100644 index 06486e3..0000000 --- a/squape-report/LICENSE +++ /dev/null @@ -1,27 +0,0 @@ -Copyright (c) 2023, Cyber Alpaca Pawłowski Topolski sp.j. -All rights reserved. - -Redistribution and use in source and binary forms, with or without -modification, are permitted provided that the following conditions are met: - -* Redistributions of source code must retain the above copyright notice, this - list of conditions and the following disclaimer. - -* Redistributions in binary form must reproduce the above copyright notice, - this list of conditions and the following disclaimer in the documentation - and/or other materials provided with the distribution. - -* Neither the name of the copyright holder nor the names of its - contributors may be used to endorse or promote products derived from - this software without specific prior written permission. - -THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" -AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE -IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE -DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE -FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL -DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR -SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER -CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, -OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE -OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. \ No newline at end of file diff --git a/squape-report/README.md b/squape-report/README.md deleted file mode 100644 index ea4ec83..0000000 --- a/squape-report/README.md +++ /dev/null @@ -1,16 +0,0 @@ -# SQUAPE - Report -Python package with features that enrich Squish reporting and verifying capabilities - -### Installation -```sh -pip install squape-report -``` - -## License -The packages are available under The 3-Clause BSD License - -## References -- [SQUAPE - Squish API Python Extension](https://github.com/CyberAlpaca/squish-api-python-extension) -- [Squish by the Qt Group](https://www.qt.io/product/quality-assurance/squish) - -[![Cyber Alpaca](https://cyberalpaca.com/static/media/cyberalpaca-logo.60f51a65.svg)](https://cyberalpaca.com) diff --git a/squape/__init__.py b/squape/__init__.py new file mode 100644 index 0000000..cacb8fe --- /dev/null +++ b/squape/__init__.py @@ -0,0 +1,6 @@ +# -*- coding: utf-8 -*- +# +# Copyright (c) 2023, Cyber Alpaca +# All rights reserved. +# This source code is licensed under the BSD-style license found in the +# LICENSE file in the root directory of this source tree. diff --git a/squape-report/squape/report.py b/squape/report.py similarity index 100% rename from squape-report/squape/report.py rename to squape/report.py diff --git a/squape-report/squape/vps.py b/squape/vps.py similarity index 100% rename from squape-report/squape/vps.py rename to squape/vps.py