Metadata-Version: 2.4
Name: alpha-python
Version: 0.6.0
Summary: Alpha is intended to be the first dependency you need to add to your Python application. It is a Python library which contains standard building blocks that can be used in applications that are used as APIs and/or make use of database interaction.
Author-email: Bart Reijling <bart@reijling.eu>
License-Expression: MIT
Project-URL: Homepage, https://github.com/breijling/alpha
Project-URL: Issues, https://github.com/breijling/alpha/issues
Project-URL: Documentation, https://alpha-python.readthedocs.io/en/latest/
Project-URL: Changelog, https://alpha-python.readthedocs.io/en/latest/changelog/
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Requires-Python: <3.15,>=3.11
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: attrs>=25.4.0
Requires-Dist: gunicorn>=23.0.0
Requires-Dist: jsonpatch>=1.33
Requires-Dist: numpy>=2.3.5
Requires-Dist: pandas>=1.13
Requires-Dist: pydantic>=2.12.5
Requires-Dist: pyjwt>=2.10.1
Requires-Dist: six>=1.17.0
Requires-Dist: sqlalchemy>=2.0.44
Requires-Dist: requests>=2.28.1
Requires-Dist: dependency-injector[yaml]!=4.48.3,<5.0.0,>=4.42.0
Requires-Dist: argon2-cffi>=25.1.0
Requires-Dist: httpx
Requires-Dist: cryptography
Provides-Extra: api-generator
Requires-Dist: openapi-generator-cli==7.14.0; extra == "api-generator"
Requires-Dist: jdk4py; extra == "api-generator"
Provides-Extra: flask
Requires-Dist: connexion[swagger-ui]<3,>=2.14.2; extra == "flask"
Requires-Dist: swagger-ui-bundle>=0.0.2; extra == "flask"
Requires-Dist: python_dateutil>=2.6.0; extra == "flask"
Requires-Dist: itsdangerous==1.1.0; extra == "flask"
Requires-Dist: MarkupSafe<2.0.2; extra == "flask"
Requires-Dist: Jinja2==2.11.2; extra == "flask"
Requires-Dist: Flask<2,>=1.1.2; extra == "flask"
Requires-Dist: Werkzeug<2.1.0,>=1.0.1; extra == "flask"
Requires-Dist: flask-cors>=3.0.10; extra == "flask"
Requires-Dist: Flask-Compress>=1.13; extra == "flask"
Provides-Extra: mysql
Requires-Dist: pymysql>=1.1.2; extra == "mysql"
Provides-Extra: postgresql
Requires-Dist: psycopg2-binary>=2.9.11; extra == "postgresql"
Provides-Extra: ldap
Requires-Dist: ldap3>=2.9.1; extra == "ldap"
Dynamic: license-file

# Alpha

Alpha is intended to be the first dependency you need to add to your Python application. It is a Python library which contains standard building blocks that can be used in applications that are used as APIs and/or make use of database interaction.

## Badges

[![PyPI version](https://badge.fury.io/py/alpha-python.svg)](https://badge.fury.io/py/alpha-python)
[![Build Status](https://travis-ci.com/breijling/alpha.svg?branch=main)](https://travis-ci.com/breijling/alpha)
[![Coverage Status](https://coveralls.io/repos/github/breijling/alpha/badge.svg?branch=main)](https://coveralls.io/github/breijling/alpha?branch=main)
[![MIT License](https://img.shields.io/badge/License-MIT-green.svg)](https://choosealicense.com/licenses/mit/)

## Documentation

[![Documentation Status](https://readthedocs.org/projects/alpha-python/badge/?version=latest)](https://alpha-python.readthedocs.io/en/latest/)

Full documentation is available at [alpha-python.readthedocs.io](https://alpha-python.readthedocs.io/).

## Installation

The library is still in development, but you can already install it using pip:

```shell
pip install alpha-python
```

If you want to use the alpha cli for generating API code, you can install it using pip as well:

```shell
pip install alpha-python[api-generator]
```

If you want to add the library to your API project, you can add it to your pyproject.toml file:

```shell
# Poetry example
poetry add alpha-python --extras "flask, postgresql"
poetry add --dev alpha-python --extras "api-generator"

# UV example
uv add alpha-python --extra flask --extra postgresql
uv add --dev alpha-python --extra api-generator
```

## Usage

The library contains a lot of different components, but the most important ones are:

- `alpha.encoder.JSONEncoder`: A JSON encoder that can be used to serialize complex objects to JSON.

## Features



## Contributing

If you want to contribute to the development of this library, you can fork the repository and create a pull request with your changes.

## License

This library is licensed under the MIT License. See the LICENSE file for more information.
