Metadata-Version: 2.1
Name: genvars
Version: 0.1.2
Summary: Generate description tables for your Pydantic's BaseSettings
Author: Mikhail Liamets
Author-email: mikhail@liamets.dev
Requires-Python: >=3.10,<4.0
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Dist: pydantic (>=2.6.1,<3.0.0)
Requires-Dist: pydantic-settings (>=2.1.0,<3.0.0)
Description-Content-Type: text/markdown

# GenVars

Generate description tables for your Pydantic BaseSettings models in Markdown.

```shell
Usage: poetry run python3 -m genvars [-h] [--output OUTPUT] modules [modules ...]

positional arguments:
  modules          Modules with settings to describe, e.g. common.settings config <...>

options:
  -h, --help       show this help message and exit
  --output OUTPUT  Output file in Markdown.
```

<!-- begin env -->
### BackupManagerSettings

|Variable|Type|Default|Description|
|--------------|--------------|--------------|--------------|
|`SCHEMA`|string|http||
|`HOST`|string|||
|`PORT`|integer|||


### ExporterSettings

|Variable|Type|Default|Description|
|--------------|--------------|--------------|--------------|
|`MAX_CONCURRENT_TASKS`|integer|10|The maximum number of concurrent tasks in the event loop.|
|`DIRECTORIES`|array|||


### PostgresSettings

|Variable|Type|Default|Description|
|--------------|--------------|--------------|--------------|
|`HOST`|string|||
|`PORT`|integer|||
|`USER`|string|||
|`PASSWORD`|string|||
|`DB`|string|||


### ProductionS3StorageSettings

|Variable|Type|Default|Description|
|--------------|--------------|--------------|--------------|
|`CONFIG_FILE_PATH`|string|~/.aws/config||
|`MAX_CONCURRENT_REQUESTS`|integer|10|The number of concurrent uploads per directory. The minimum count of threads on my system was 6 with the concurrency value of 1. https://docs.aws.amazon.com/cli/latest/topic/s3-config.html#max-concurrent-requests|
|`MAX_QUEUE_SIZE`|integer|1000|https://docs.aws.amazon.com/cli/latest/topic/s3-config.html#max-queue-size|
|`MULTIPART_THRESHOLD`|string|8MB|https://docs.aws.amazon.com/cli/latest/topic/s3-config.html#multipart-threshold|
|`MULTIPART_CHUNKSIZE`|string|8MB|https://docs.aws.amazon.com/cli/latest/topic/s3-config.html#multipart-chunksize|
|`MAX_BANDWIDTH`|string, null|None|https://docs.aws.amazon.com/cli/latest/topic/s3-config.html#max-bandwidth|
|`ARGS`|array|['--size-only']|Arbitrary keyword arguments to be passed to the AWS CLI command.|
|`ACCESS_KEY_ID`|string|||
|`SECRET_ACCESS_KEY`|string|||
|`ENDPOINT_URL`|string|||
|`REGION`|string|||
|`BUCKET_NAME`|string||Name of the bucket to be used.|


### TenacitySettings

|Variable|Type|Default|Description|
|--------------|--------------|--------------|--------------|
|`MAX_RETRIES_COUNT`|integer|-1|-1 means infinite retries|
|`WAIT_MULTIPLIER`|integer|2|Exponential backoff multiplier|
|`MAX_WAIT_TIME`|integer|10|Maximum wait time in seconds|
<!-- end env -->

