backend.src.libs.bucket.bucket_constants Namespace Reference

Functions
str	_get_environement_variable (Dict[str, Optional[str]] environement, str variable_name, bool required=True)

Variables
Disp	IDISP = initialise_logger("Bucket Constants", False)
	_DOTENV = dict(dotenv.dotenv_values())
	_OS_ENV = dict(os.environ)
dict	ENV = {}
str	BUCKET_RESSOURCE_TYPE = "s3"
str	BUCKET_SIGNATURE_VERSION
str	BUCKET_HOST = _get_environement_variable(ENV, "BUCKET_HOST")
str	BUCKET_PORT
str	BUCKET_USER = _get_environement_variable(ENV, "BUCKET_USER")
str	BUCKET_PASSWORD

Detailed Description

# +==== BEGIN CatFeeder =================+
# LOGO:
# ..............(..../\
# ...............)..(.')
# ..............(../..)
# ...............\‍(__)|
# Inspired by Joan Stark
# source https://www.asciiart.eu/
# animals/cats
# /STOP
# PROJECT: CatFeeder
# FILE: bucket_constants.py
# CREATION DATE: 18-11-2025
# LAST Modified: 14:42:10 19-12-2025
# DESCRIPTION:
# This is the backend server in charge of making the actual website work.
# /STOP
# COPYRIGHT: (c) Cat Feeder
# PURPOSE: File in charge of containing the constants required for the bucket wrapper.
# // AR
# +==== END CatFeeder =================+

Function Documentation

_get_environement_variable()

str backend.src.libs.bucket.bucket_constants._get_environement_variable ( Dict[str, Optional[str]] environement, str variable_name, bool required = True )

protected

_summary_
    Get the content of an environement variable.

Args:
    variable_name (str): _description_
    required (bool): If False, return empty string if variable not found. Defaults to True.

Returns:
    str: _description_: the value of that variable, otherwise an exception is raised.

Definition at line 41 of file bucket_constants.py.

Variable Documentation

_DOTENV

backend.src.libs.bucket.bucket_constants._DOTENV = dict(dotenv.dotenv_values())

protected

Definition at line 34 of file bucket_constants.py.

_OS_ENV

backend.src.libs.bucket.bucket_constants._OS_ENV = dict(os.environ)

protected

Definition at line 35 of file bucket_constants.py.

BUCKET_HOST

str backend.src.libs.bucket.bucket_constants.BUCKET_HOST = _get_environement_variable(ENV, "BUCKET_HOST")

Definition at line 73 of file bucket_constants.py.

BUCKET_PASSWORD

str backend.src.libs.bucket.bucket_constants.BUCKET_PASSWORD

Initial value:

=  _get_environement_variable(
    ENV,
    "BUCKET_PASSWORD"
)

Definition at line 77 of file bucket_constants.py.

BUCKET_PORT

str backend.src.libs.bucket.bucket_constants.BUCKET_PORT

Initial value:

=  _get_environement_variable(
    ENV, "BUCKET_PORT", required=False)

Definition at line 74 of file bucket_constants.py.

BUCKET_RESSOURCE_TYPE

str backend.src.libs.bucket.bucket_constants.BUCKET_RESSOURCE_TYPE = "s3"

Definition at line 67 of file bucket_constants.py.

BUCKET_SIGNATURE_VERSION

str backend.src.libs.bucket.bucket_constants.BUCKET_SIGNATURE_VERSION

Initial value:

=  _get_environement_variable(
    ENV, "BUCKET_SIGNATURE_VERSION", required=False) or "s3v4"

Definition at line 70 of file bucket_constants.py.

BUCKET_USER

str backend.src.libs.bucket.bucket_constants.BUCKET_USER = _get_environement_variable(ENV, "BUCKET_USER")

Definition at line 76 of file bucket_constants.py.

ENV

dict backend.src.libs.bucket.bucket_constants.ENV = {}

Definition at line 36 of file bucket_constants.py.

IDISP

Disp backend.src.libs.bucket.bucket_constants.IDISP = initialise_logger("Bucket Constants", False)

Definition at line 30 of file bucket_constants.py.