From cbcb53c3aba05ce43dd60c0a3dc033d2cab12b79 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Piotr=20Gr=C3=B3dek?= Date: Fri, 3 Nov 2023 15:02:22 +0100 Subject: [PATCH] Add long description for the package --- DESCRIPTION.rst | 13 +++++++++++++ setup.cfg | 3 +-- 2 files changed, 14 insertions(+), 2 deletions(-) create mode 100644 DESCRIPTION.rst diff --git a/DESCRIPTION.rst b/DESCRIPTION.rst new file mode 100644 index 0000000..24143a2 --- /dev/null +++ b/DESCRIPTION.rst @@ -0,0 +1,13 @@ +`deepsense.ai `_ **ds_pycontain** +------------------------------------------------------------- + +**ds_pycontain** is a small python package to help with docker containers and images. + +Example use case you might consider is to isolate python code execution generated by untrusted LLM by running it in a docker container. + +This package makes it a bit easier to: + +* Build docker images from Dockerfiles or in-memory string. +* Pull docker images from dockerhub (or similar). +* Run docker container to execute a one-off command. +* Run docker container to execute a long-running process and communicate with it. diff --git a/setup.cfg b/setup.cfg index 2a6d83e..602140f 100644 --- a/setup.cfg +++ b/setup.cfg @@ -3,8 +3,7 @@ name = ds_pycontain # do not change version by hand: use bump_version.sh version = file: src/ds_pycontain/VERSION description = "deepsense.ai wrapper around docker python API" -long_description = file: DESCRIPTION.md -long_description_content_type = text/markdown +long_description = file: DESCRIPTION.rst author = deepsense.ai author_email = contact@deepsense.ai license = MIT License (MIT)