Description:
genvars 0.1.3
GenVars
Generate description tables for your Pydantic BaseSettings models in Markdown.
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.
PostgresSettings
Variable
Type
Default
Description
HOST
string
PORT
integer
USER
string
PASSWORD
string
DB
string
ManagerSettings
Variable
Type
Default
Description
MAX_CONCURRENT_EVENT_WORKERS
integer
10
The maximum number of concurrent tasks in the event loop to process incoming events.
MAX_CONCURRENT_RESTORATION_TASKS
integer
10
The maximum number of concurrent tasks in the event loop to process incoming restoration tasks.
MAX_CONCURRENT_RESTORATION_WORKERS
integer
10
The maximum number of concurrent restoration workers per restoration task in the event loop to run file-wise restoration. Thus, 10 tasks will spawn 10 workers each, amounting to 100 coroutines running at once.
BATCH_SIZE
integer
10
How many files to fetch from the snapshot for restoration at once.
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.
AWSS3CliSettings
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.
S3StorageSettings
Variable
Type
Default
Description
ACCESS_KEY_ID
string
SECRET_ACCESS_KEY
string
ENDPOINT_URL
string
REGION
string
TapeS3StorageSettings
Variable
Type
Default
Description
ACCESS_KEY_ID
string
SECRET_ACCESS_KEY
string
ENDPOINT_URL
string
REGION
string
BUCKET_NAME
string
Name of the bucket to be used.
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
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
License
For personal and professional use. You cannot resell or redistribute these repositories in their original state.
Customer Reviews
There are no reviews.
