Metadata-Version: 2.1
Name: docknet
Version: 0.0.23
Summary: Python package template.
Home-page: https://github.com/khulnasoft/docknet
Author: KhulnaSoft DevOps Team
Author-email: info@khulnasoft.com
License: MIT
Project-URL: Changelog, https://github.com/khulnasoft/docknet/releases
Project-URL: Issue Tracker, https://github.com/khulnasoft/docknet/issues
Project-URL: Documentation, https://github.com/khulnasoft/docknet#documentation
Project-URL: Source, https://github.com/khulnasoft/docknet
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: Intended Audience :: Information Technology
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: Implementation :: PyPy
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Topic :: Software Development
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Utilities
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: typer
Requires-Dist: pydantic[dotenv,email]
Requires-Dist: fastapi==0.75.2
Requires-Dist: requests
Requires-Dist: loguru
Requires-Dist: filetype
Requires-Dist: addict
Requires-Dist: requests-toolbelt
Requires-Dist: shortuuid
Requires-Dist: slugify
Provides-Extra: dev
Requires-Dist: setuptools; extra == "dev"
Requires-Dist: wheel; extra == "dev"
Requires-Dist: twine; extra == "dev"
Requires-Dist: flake8; extra == "dev"
Requires-Dist: pytest; extra == "dev"
Requires-Dist: pytest-mock; extra == "dev"
Requires-Dist: pytest-cov; extra == "dev"
Requires-Dist: mypy; extra == "dev"
Requires-Dist: types-python-slugify; extra == "dev"
Requires-Dist: types-requests; extra == "dev"
Requires-Dist: types-cachetools; extra == "dev"
Requires-Dist: black; extra == "dev"
Requires-Dist: pydocstyle; extra == "dev"
Requires-Dist: isort; extra == "dev"
Requires-Dist: docsai; extra == "dev"
Requires-Dist: locust; extra == "dev"
Requires-Dist: pyinstrument; extra == "dev"
Requires-Dist: pytest-profiling; extra == "dev"
Requires-Dist: devtools[pygments]; extra == "dev"
Requires-Dist: ipykernel; extra == "dev"
Requires-Dist: ml-buildkit; extra == "dev"
Requires-Dist: requests; extra == "dev"
Provides-Extra: server
Requires-Dist: kubernetes; extra == "server"
Requires-Dist: docker; extra == "server"
Requires-Dist: fastapi-utils; extra == "server"
Requires-Dist: python-multipart; extra == "server"
Requires-Dist: streaming-form-data; extra == "server"
Requires-Dist: psutil; extra == "server"
Requires-Dist: uvicorn; extra == "server"
Requires-Dist: colorama; extra == "server"
Requires-Dist: sqlalchemy<=1.4.46; extra == "server"
Requires-Dist: psycopg2; extra == "server"
Requires-Dist: shortuuid; extra == "server"
Requires-Dist: python-slugify; extra == "server"
Requires-Dist: minio; extra == "server"
Requires-Dist: azure-storage-blob; extra == "server"
Requires-Dist: python-jose[cryptography]; extra == "server"
Requires-Dist: passlib[bcrypt]; extra == "server"
Requires-Dist: json-merge-patch; extra == "server"
Requires-Dist: jsonpath-ng; extra == "server"
Requires-Dist: jinja2; extra == "server"
Requires-Dist: requests-oauthlib; extra == "server"
Requires-Dist: faker; extra == "server"

# Python Library Template

_WIP: Document python library._

## Requirements

* Python 3.6+

## Installation

Install via pip:

```bash
pip install --upgrade -e path/to/lib
```

## Usage

After installation, the package can be imported:

```python
import template_package
```

## Development

This library uses [black](https://github.com/psf/black) for auto-formatting, [isort](https://github.com/PyCQA/isort) for import sorting, [flake8](https://github.com/PyCQA/flake8) for linting, [mypy](https://github.com/python/mypy) for type checking, and [pydocstyle](https://github.com/PyCQA/pydocstyle) for docstring style checks. All code is written compatible with Python 3.6+, with type hints wherever possible.

## Testing

* DeploymentManager:
  * By default, just the DockerDeploymentManager is executed. To execute also the Kubernetes-related tests, a Kubernetes cluster has to be available from where the code is executed. On your local Mac, you can simply start one by executing `kind create cluster`. Then execute the tests by setting the environment variable `KUBE_AVAILABLE=true` (in VS Code, you can for example set the env variable in the `launch.json` or append it in front of the pytest command, e.g. `KUBE_AVAILABLE=true pytest...`)
