Metadata-Version: 2.4
Name: blackant-sdk
Version: 1.0.2
Summary: Python SDK for Docker operations with automatic authentication through BlackAnt platform
Author-email: Balázs Milán <milan.balazs@uni-obuda.hu>
Maintainer-email: BlackAnt Development Team <dev@blackant.app>
License: Proprietary - Óbudai Egyetem
Project-URL: Homepage, https://env.blackant.app/systemdevelopers/blackant_sdk
Project-URL: Documentation, https://docs.blackant.app
Project-URL: Repository, https://env.blackant.app/systemdevelopers/blackant_sdk
Project-URL: Bug Tracker, https://env.blackant.app/systemdevelopers/blackant_sdk/-/issues
Keywords: docker,sdk,authentication,blackant,container,orchestration,swarm
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: System :: Distributed Computing
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Operating System :: OS Independent
Requires-Python: >=3.11
Description-Content-Type: text/markdown
Requires-Dist: flask>=2.3.2
Requires-Dist: flask-restful>=0.3.10
Requires-Dist: waitress>=2.1.2
Requires-Dist: minio>=6.0.0
Requires-Dist: requests>=2.31.0
Requires-Dist: docker>=4.4.3
Requires-Dist: urllib3<2.0
Requires-Dist: gunicorn>=21.2.0
Requires-Dist: colorama>=0.4.6
Requires-Dist: python-keycloak>=3.0.0
Requires-Dist: PyJWT>=2.8.0
Provides-Extra: dev
Requires-Dist: pytest>=7.0.0; extra == "dev"
Requires-Dist: pytest-cov>=4.0.0; extra == "dev"
Requires-Dist: pytest-mock>=3.10.0; extra == "dev"
Requires-Dist: sphinx>=5.0.0; extra == "dev"
Requires-Dist: sphinx-rtd-theme>=1.0.0; extra == "dev"
Provides-Extra: test
Requires-Dist: pytest>=7.0.0; extra == "test"
Requires-Dist: pytest-cov>=4.0.0; extra == "test"
Requires-Dist: pytest-mock>=3.10.0; extra == "test"
Provides-Extra: docs
Requires-Dist: sphinx>=5.0.0; extra == "docs"
Requires-Dist: sphinx-rtd-theme>=1.0.0; extra == "docs"

# Python REST API docker template

A simple template to implement REST APIs using Python Flask & docker.

## Build arguments

### INSTALL_DEBUG_TOOLS

If it's set to True, ptvsd is installed during build to be able to do live debugging.

## Environment variables

### CALCULATION_NAME

Name of the calculation. Mandatory parameter.

### SERVER_PORT

Port which on the server runs. Default: 5000

### DEBUG_MODE

A switch to select between debug and release mode. If it is set to True, a Flask server will be started in debug mode and a ptvsd server. Otherwise, it is served using gevent production server. Default: False

### OBJECT_STORAGE_URL

Url for the object storage. Mandatory if the code uses object storage.

### OBJECT_STORAGE_ACCESS_KEY

Public key for the object storage.

### OBJECT_STORAGE_SECRET_KEY

Private key for the object storage.

### SCHEDULER_URL

Callback url of the scheduler.

## Commands

### Build

```sh
docker-compose build
```

### Run

```sh
docker-compose up
```

### Create task

You can use the tools/send_request.py script to send a simple request to the calculation container.

### Debug

If you use Visual Studio Code, there is a debug configuration called Python: Remote Attach which will start a debug session and connect to your running container.

## Documentation

Full HTML and PDF documentation can be generated from any revision using the generate_documentation job in the CI.
After the job have run successfully, the artifacts are stored for one day.
If it's necessary it can be rerun any time.


......
