Metadata-Version: 2.2
Name: aplustools
Version: 2.0.0.0a12
Summary: A collection of helpful tools
Author-email: Cariel Becker <cariel.becker@gmx.de>
Maintainer-email: Cariel Becker <cariel.becker@gmx.de>
License: LGPL-2.1-or-later
Project-URL: Home, https://pypi.org/project/aplustools/
Project-URL: Repository, https://github.com/adalfarus/aplustools
Project-URL: Documentation, https://github.com/adalfarus/aplustools/wiki
Project-URL: Issue tracker, https://github.com/adalfarus/aplustools/issues
Keywords: general,tools,app tools,production,apt
Classifier: License :: OSI Approved :: GNU Lesser General Public License v2 or later (LGPLv2+)
Classifier: Development Status :: 5 - Production/Stable
Classifier: Programming Language :: Python
Classifier: Natural Language :: English
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: packaging
Requires-Dist: pywin32>=306; os_name == "nt"
Requires-Dist: cachetools>=5.5.0
Provides-Extra: data
Requires-Dist: Pillow>=10.3.0; extra == "data"
Requires-Dist: opencv-python>=4.9.0.80; extra == "data"
Requires-Dist: pillow_heif==0.15.0; extra == "data"
Requires-Dist: numpy==1.26.4; extra == "data"
Requires-Dist: brotli>=1.1.0; extra == "data"
Requires-Dist: zstandard>=0.22.0; extra == "data"
Requires-Dist: py7zr>=0.21.0; extra == "data"
Requires-Dist: requests>=2.32.0; extra == "data"
Requires-Dist: BeautifulSoup4>=4.12.2; extra == "data"
Requires-Dist: cachetools>=5.5.0; extra == "data"
Provides-Extra: io
Requires-Dist: windows-toasts>=1.1.1; os_name == "nt" and extra == "io"
Requires-Dist: psutil>=6.0.0; extra == "io"
Requires-Dist: pywin32>=306; extra == "io"
Requires-Dist: PySide6>=6.7.0; extra == "io"
Provides-Extra: package
Requires-Dist: numpy>=1.26.4; extra == "package"
Requires-Dist: scipy>=1.13.0; extra == "package"
Requires-Dist: scikit-learn>=1.5.2; extra == "package"
Provides-Extra: security
Requires-Dist: cryptography>=42.0.5; extra == "security"
Requires-Dist: quantcrypt>=0.4.2; python_version == "3.12" and extra == "security"
Requires-Dist: zxcvbn>=4.4.28; extra == "security"
Requires-Dist: bcrypt>=4.1.2; extra == "security"
Provides-Extra: web
Requires-Dist: requests>=2.32.0; extra == "web"
Requires-Dist: BeautifulSoup4>=4.12.2; extra == "web"
Requires-Dist: aiohttp>=3.9.5; extra == "web"
Provides-Extra: dev
Requires-Dist: pytest; extra == "dev"
Provides-Extra: all
Requires-Dist: Pillow>=10.4.0; extra == "all"
Requires-Dist: aiohttp>=3.9.4; extra == "all"
Requires-Dist: opencv-python>=4.9.0.80; extra == "all"
Requires-Dist: pillow_heif>=0.15.0; extra == "all"
Requires-Dist: numpy>=1.26.4; extra == "all"
Requires-Dist: brotli>=1.1.0; extra == "all"
Requires-Dist: zstandard>=0.22.0; extra == "all"
Requires-Dist: py7zr>=0.21.0; extra == "all"
Requires-Dist: requests>=2.32.0; extra == "all"
Requires-Dist: BeautifulSoup4>=4.12.2; extra == "all"
Requires-Dist: windows-toasts>=1.1.1; os_name == "nt" and extra == "all"
Requires-Dist: scipy>=1.13.0; extra == "all"
Requires-Dist: scikit-learn>=1.4.1.post1; os_name == "nt" and extra == "all"
Requires-Dist: scikit-learn; os_name != "nt" and extra == "all"
Requires-Dist: cryptography>=42.0.5; extra == "all"
Requires-Dist: quantcrypt>=0.4.2; python_version == "3.12" and extra == "all"
Requires-Dist: pytest; extra == "all"
Requires-Dist: zxcvbn>=4.4.28; extra == "all"
Requires-Dist: bcrypt>=4.1.2; extra == "all"
Requires-Dist: psutil>=6.0.0; extra == "all"
Requires-Dist: pywin32>=306; extra == "all"
Requires-Dist: cachetools>=5.5.0; extra == "all"
Requires-Dist: PySide6>=6.7.0; extra == "all"

[![Active Development](https://img.shields.io/badge/Maintenance%20Level-Actively%20Developed-brightgreen.svg)](https://gist.github.com/cheerfulstoic/d107229326a01ff0f333a1d3476e068d)
[![CI Test Status](https://github.com/Adalfarus/aplustools/actions/workflows/test-package.yml/badge.svg)](https://github.com/Adalfarus/aplustools/actions)
[![License: LGPL-2.1](https://img.shields.io/github/license/Adalfarus/aplustools)](https://github.com/Adalfarus/aplustools/blob/main/LICENSE)

# aplustools2

aplustools2 is a simple, user-friendly Python library for performing amazing tasks. It simplifies complex processes, allowing you to achieve more with less code. Developed with a focus on ease of use and efficiency, aplustools is the go-to solution for Python developers looking to enhance their projects.

## Compatibility
🟩 (Works perfectly); 🟨 (Untested); 🟧 (Some Issues); 🟥 (Unusable)

| OS                       | UX & README instructions | Tests | More Complex Functionalities |
|--------------------------|--------------------------|-------|------------------------------|
| Windows                  | 🟩                       | 🟩    | 🟩                           |
| MacOS                    | 🟨                       | 🟩    | 🟨                           |
| Linux (Ubuntu 22.04 LTS) | 🟩                       | 🟩    | 🟨                           |

## Features

- Easy to use for beginners, but not lacking for experts
- Pretty efficient
- Supports the three main platforms
- Regular updates and support
- Comprehensive documentation

## Installation

You can install aplustools2 via pip:

```sh
pip install aplustools[all]>=2.0.0.0 --upgrade
```

Or clone the repository and install manually:

```sh
git clone https://github.com/Adalfarus/aplustools.git
cd aplustools
python -m build
```

## Usage

Here are a few quick examples of how to use aplustools:

- Examples will be added in the full release.

(If you have problems with the package please use `py -3.12 -m pip install aplustools[all]>=2.0.0.0 --upgrade --user`)
(The standard shortform for aplustools is aps, so please use ```import aplustools as aps``` for consistency)

### aps cli
Can currently run tests with ```aps tests run tests/ -minimal``` and show a basic help using ```aps help```.

For more detailed usage and examples, check out our [documentation](https://github.com/adalfarus/aplustools/wiki).

## Naming convention, dependencies and library information
[PEP 8 -- Style Guide for Python Code](https://peps.python.org/pep-0008/#naming-conventions)

For modules I use 'lowercase', classes are 'CapitalizedWords' and functions and methods are 'lower_case_with_underscores'.

### Information
- Additional information will be added in the full release.

## Contributing

We welcome contributions! Please see our [contributing guidelines](https://github.com/adalfarus/aplustools/blob/main/CONTRIBUTING.md) for more details on how you can contribute to aplustools.

1. Fork the repository
2. Create your feature branch (`git checkout -b feature/AmazingFeature`)
3. Commit your changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the branch (`git push origin feature/AmazingFeature`)
5. Open a pull request

### Aps Build master

You can use the aps_build_master script for your os to make your like a lot easier.
It supports running tests, installing, building and much more as well as chaining together as many commands as you like.

This example runs test, build the project and then installs it
````commandline
call .\aps_build_master.bat 234
````

````shell
sudo apt install python3-pip
sudo apt install python3-venv
chmod +x ./aps_build_master.sh
./aps_build_master.sh 234
````

## License

aplustools is licensed under the LGPL-2.1 License - see the [LICENSE](https://github.com/adalfarus/aplustools/blob/main/LICENSE) file for details.
