Metadata-Version: 2.4
Name: ccdcoe
Version: 0.0.22
Summary: Package with general devops code
Home-page: https://github.com/ccdcoe/ccdcoe
Author: CCDCOE
Author-email: ccdcoe@invalid.com
License: GNU General Public License v3.0
Project-URL: Code, https://github.com/ccdcoe/ccdcoe
Platform: any
Classifier: Development Status :: 5 - Production/Stable
Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Operating System :: OS Independent
Requires-Python: >=3.10,<4.0
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: setuptools>=68.1.0
Provides-Extra: flask-plugins-kafka
Requires-Dist: kafka-python>=2.0.2; extra == "flask-plugins-kafka"
Provides-Extra: flask-middleware
Requires-Dist: rfc3339>=6.2; extra == "flask-middleware"
Provides-Extra: flask-plugins
Requires-Dist: flask>=2.3.3; extra == "flask-plugins"
Requires-Dist: sqlalchemy>=2.0.21; extra == "flask-plugins"
Requires-Dist: flask-sqlalchemy>=3.1.1; extra == "flask-plugins"
Requires-Dist: flask-migrate>=4.0.5; extra == "flask-plugins"
Requires-Dist: werkzeug>=2.3.7; extra == "flask-plugins"
Requires-Dist: mysqlclient<3.0.0,>=2.2.7; extra == "flask-plugins"
Provides-Extra: loggers
Requires-Dist: ansicolors>=1.1.8; extra == "loggers"
Provides-Extra: flask-managers
Requires-Dist: gunicorn>=21.2.0; extra == "flask-managers"
Requires-Dist: flask>=2.3.3; extra == "flask-managers"
Requires-Dist: pyopenssl>=23.2.0; extra == "flask-managers"
Requires-Dist: werkzeug>=2.3.7; extra == "flask-managers"
Requires-Dist: flask-socketio>=5.3.6; extra == "flask-managers"
Provides-Extra: sso
Requires-Dist: authlib>=1.6.4; extra == "sso"
Requires-Dist: flask>=2.3.3; extra == "sso"
Requires-Dist: pyjwt>=2.8.0; extra == "sso"
Provides-Extra: common
Requires-Dist: python-gitlab<7.0.0,>=6.3.0; extra == "common"
Requires-Dist: python-dotenv<2.0.0,>=1.0.1; extra == "common"
Requires-Dist: dataclasses-json<0.7.0,>=0.6.7; extra == "common"
Provides-Extra: cli
Requires-Dist: tabulate<0.10.0,>=0.9.0; extra == "cli"
Requires-Dist: click<9.0.0,>=8.1.8; extra == "cli"
Provides-Extra: http-apis
Requires-Dist: requests>=2.31.0; extra == "http-apis"
Provides-Extra: deployments
Requires-Dist: tqdm<5.0.0,>=4.67.1; extra == "deployments"
Provides-Extra: cache-redis
Requires-Dist: redis>=5.0.0; extra == "cache-redis"
Provides-Extra: flask-plugins-es
Requires-Dist: eswrap>=0.5.0; extra == "flask-plugins-es"
Requires-Dist: elasticsearch>=8.7.0; extra == "flask-plugins-es"
Provides-Extra: dumpers
Requires-Dist: pyyaml<7.0.0,>=6.0.2; extra == "dumpers"
Provides-Extra: auth
Requires-Dist: python-ldap>=3.4.3; extra == "auth"
Provides-Extra: gitlab-bot
Requires-Dist: python-gitlab<7.0.0,>=6.3.0; extra == "gitlab-bot"
Requires-Dist: ansicolors>=1.1.8; extra == "gitlab-bot"
Requires-Dist: redis>=5.0.0; extra == "gitlab-bot"
Requires-Dist: dataclasses-json<0.7.0,>=0.6.7; extra == "gitlab-bot"
Requires-Dist: python-dotenv<2.0.0,>=1.0.1; extra == "gitlab-bot"
Provides-Extra: cli-code
Requires-Dist: pyyaml<7.0.0,>=6.0.2; extra == "cli-code"
Requires-Dist: click<9.0.0,>=8.1.8; extra == "cli-code"
Requires-Dist: requests>=2.31.0; extra == "cli-code"
Requires-Dist: tabulate<0.10.0,>=0.9.0; extra == "cli-code"
Requires-Dist: ansicolors>=1.1.8; extra == "cli-code"
Requires-Dist: python-dotenv<2.0.0,>=1.0.1; extra == "cli-code"
Requires-Dist: tqdm<5.0.0,>=4.67.1; extra == "cli-code"
Requires-Dist: dataclasses-json<0.7.0,>=0.6.7; extra == "cli-code"
Requires-Dist: python-gitlab<7.0.0,>=6.3.0; extra == "cli-code"
Provides-Extra: deployment-code
Requires-Dist: python-gitlab<7.0.0,>=6.3.0; extra == "deployment-code"
Requires-Dist: requests>=2.31.0; extra == "deployment-code"
Requires-Dist: ansicolors>=1.1.8; extra == "deployment-code"
Requires-Dist: tqdm<5.0.0,>=4.67.1; extra == "deployment-code"
Requires-Dist: dataclasses-json<0.7.0,>=0.6.7; extra == "deployment-code"
Requires-Dist: python-dotenv<2.0.0,>=1.0.1; extra == "deployment-code"
Provides-Extra: web-flask
Requires-Dist: click<9.0.0,>=8.1.8; extra == "web-flask"
Requires-Dist: python-ldap>=3.4.3; extra == "web-flask"
Requires-Dist: flask-socketio>=5.3.6; extra == "web-flask"
Requires-Dist: pyjwt>=2.8.0; extra == "web-flask"
Requires-Dist: flask-sqlalchemy>=3.1.1; extra == "web-flask"
Requires-Dist: dataclasses-json<0.7.0,>=0.6.7; extra == "web-flask"
Requires-Dist: tabulate<0.10.0,>=0.9.0; extra == "web-flask"
Requires-Dist: flask-migrate>=4.0.5; extra == "web-flask"
Requires-Dist: pyopenssl>=23.2.0; extra == "web-flask"
Requires-Dist: authlib>=1.6.4; extra == "web-flask"
Requires-Dist: flask>=2.3.3; extra == "web-flask"
Requires-Dist: ansicolors>=1.1.8; extra == "web-flask"
Requires-Dist: redis>=5.0.0; extra == "web-flask"
Requires-Dist: python-dotenv<2.0.0,>=1.0.1; extra == "web-flask"
Requires-Dist: mysqlclient<3.0.0,>=2.2.7; extra == "web-flask"
Requires-Dist: sqlalchemy>=2.0.21; extra == "web-flask"
Requires-Dist: werkzeug>=2.3.7; extra == "web-flask"
Requires-Dist: rfc3339>=6.2; extra == "web-flask"
Requires-Dist: gunicorn>=21.2.0; extra == "web-flask"
Requires-Dist: python-gitlab<7.0.0,>=6.3.0; extra == "web-flask"
Provides-Extra: all
Requires-Dist: click<9.0.0,>=8.1.8; extra == "all"
Requires-Dist: requests>=2.31.0; extra == "all"
Requires-Dist: tqdm<5.0.0,>=4.67.1; extra == "all"
Requires-Dist: dataclasses-json<0.7.0,>=0.6.7; extra == "all"
Requires-Dist: tabulate<0.10.0,>=0.9.0; extra == "all"
Requires-Dist: elasticsearch>=8.7.0; extra == "all"
Requires-Dist: flask>=2.3.3; extra == "all"
Requires-Dist: authlib>=1.6.4; extra == "all"
Requires-Dist: ansicolors>=1.1.8; extra == "all"
Requires-Dist: eswrap>=0.5.0; extra == "all"
Requires-Dist: python-dotenv<2.0.0,>=1.0.1; extra == "all"
Requires-Dist: rfc3339>=6.2; extra == "all"
Requires-Dist: gunicorn>=21.2.0; extra == "all"
Requires-Dist: pyyaml<7.0.0,>=6.0.2; extra == "all"
Requires-Dist: python-ldap>=3.4.3; extra == "all"
Requires-Dist: flask-socketio>=5.3.6; extra == "all"
Requires-Dist: pyjwt>=2.8.0; extra == "all"
Requires-Dist: flask-sqlalchemy>=3.1.1; extra == "all"
Requires-Dist: flask-migrate>=4.0.5; extra == "all"
Requires-Dist: pyopenssl>=23.2.0; extra == "all"
Requires-Dist: redis>=5.0.0; extra == "all"
Requires-Dist: mysqlclient<3.0.0,>=2.2.7; extra == "all"
Requires-Dist: kafka-python>=2.0.2; extra == "all"
Requires-Dist: sqlalchemy>=2.0.21; extra == "all"
Requires-Dist: werkzeug>=2.3.7; extra == "all"
Requires-Dist: python-gitlab<7.0.0,>=6.3.0; extra == "all"
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: home-page
Dynamic: license
Dynamic: license-file
Dynamic: platform
Dynamic: project-url
Dynamic: provides-extra
Dynamic: requires-dist
Dynamic: requires-python
Dynamic: summary

# CCDCOE package

[![GitHub Release](https://img.shields.io/github/release/ccdcoe/ccdcoe.svg?style=flat)]()
[![GPLv3 License](https://img.shields.io/badge/License-GPL%20v3-yellow.svg)](https://opensource.org/licenses/)

![pypi](https://github.com/ccdcoe/ccdcoe/actions/workflows/package_to_pypi.yaml/badge.svg)

This package contains generic re-usable code.

Install the full package:

```
pip install ccdcoe[all]
```

Package has several modules which can be installed separately by specifying them 
as an extra requirement. To install the http_apis module only, specify:

```
pip install ccdcoe[http_apis]
```
Or for multiple modules:
```
pip install ccdcoe[http_apis, loggers]
```

## Adding modules and/or groups

Everything for this package is defined in the pyproject.toml file. Dependencies are managed by poetry and grouped in, you guessed it, groups. Every poetry group can be installed as an extra using pip. 

Extra extras or group on group/extra dependencies can also be defined in the [tool.ccdcoe.group.dependencies] section. Everything defined here will also become an extra if no group already exists. You can use everything defined here as dependency for another group, order does **not** matter.

example:
```toml
[tool.ccdcoe.group.dependencies]
my_awesome_extra = ["my_awesome_group", "my_other_group"]
my_awesome_group = ["my_logging_group"]

[tool.poetry.group.my_awesome_group.dependencies]
<dependency here>

[tool.poetry.group.my_other_group.dependencies]
<dependency here>

[tool.poetry.group.my_logging_group.dependencies]
<dependency here>
```

Using this example the following extras exist with the correct dependencies:
```
pip install ccdcoe[all]
pip install ccdcoe[my-awesome-extra]
pip install ccdcoe[my-awesome-group]
pip install ccdcoe[my-other-group]
pip install ccdcoe[my-logging-group]
```

## Modules

The following modules are available in the ccdcoe package:

* http_apis
* loggers
* dumpers
* deployments
* cli
* redis_cache
* flask_managers
* flask_middleware
* flask_plugins
* auth
* sso
* plugins
* sql_migrations

### HTTP apis

Baseclass for http api communication is present under 
ccdcoe.http_apis.base_class.api_base_class.ApiBaseClass

### Loggers

There are three loggers provided:
* ConsoleLogger (ccdcoe.loggers.app_logger.ConsoleLogger)
* AppLogger (ccdcoe.loggers.app_logger.AppLogger)
* GunicornLogger (ccdcoe.loggers.app_logger.GunicornLogger)

The ConsoleLogger is intended as a loggerClass for cli applications.

The AppLogger is intended to be used as a loggerClass to be used for the 
standard python logging module.

```python
import logging
from ccdcoe.loggers.app_logger import AppLogger

logging.setLoggerClass(AppLogger)

mylogger = logging.getLogger(__name__)
```
The 'mylogger' instance has all the proper formatting and handlers 
(according to the desired config) to log messages.

The Gunicorn logger is intended to be used for as a loggerClass for the 
gunicorn webserver; it enables the FlaskAppManager to set the necessary 
formatting and handles according to the AppLogger specs and a custom format
for the gunicorn access logging.

### Flask app manager

The FlaskAppManager is intended to be used to 'run' flask applications in 
both test, development as in production environments. 

```python
from YADA import app
from ccdcoe.flask_managers.flask_app_manager import FlaskAppManager

fam = FlaskAppManager(version="1.0", app=app)
fam.run()
```
Depending on the configuration the FlaskAppManager uses a werkzeug (DEBUG == True)
or a gunicorn webserver. TLS could be set for both webservers iaw the module specific
README.md.

### SQL Migrations

The sql migrations can be used to facilitate migration between different
versions of sql models / versions. It relies on flask migrate to perform
the different migrations. It has a CLI as well as an python class based API.

Check the command line help
```
python3 -m ccdcoe.sql_migrations.flask_sql_migrate -a /path/to/script_with_flask_app.py -i
python3 -m ccdcoe.sql_migrations.flask_sql_migrate -a /path/to/script_with_flask_app.py -m
python3 -m ccdcoe.sql_migrations.flask_sql_migrate -a /path/to/script_with_flask_app.py -u
```

Or initiate the FlaskSqlMigrate as a class and initiate the migration 
process from there: 
```python
from ccdcoe.sql_migrations.flask_sql_migrate import FlaskSqlMigrate
fsm = FlaskSqlMigrate(app_ref="/path/to/script_with_flask_app.py")

fsm.db_init()
fsm.db_migrate()
fsm.db_update()
```
