cookiecutter_python.backend package

Subpackages

• cookiecutter_python.backend.error_handling package
  • Submodules
  • cookiecutter_python.backend.error_handling.handler_builder module
    • CriticalHandlerBuilder
    • HandlerBuilder
      • HandlerBuilder.subclasses
    • NonCriticalHandlerBuilder
  • Module contents
    • HandlerBuilder
      • HandlerBuilder.subclasses
• cookiecutter_python.backend.generator package
  • Submodules
  • cookiecutter_python.backend.generator.generator module
  • Module contents
• cookiecutter_python.backend.hosting_services package
  • Submodules
  • cookiecutter_python.backend.hosting_services.check_engine module
    • Engine
      • Engine.check()
      • Engine.checker
      • Engine.config_file
      • Engine.create()
      • Engine.default_config
      • Engine.handle()
      • Engine.handlers
      • Engine.services_info
  • cookiecutter_python.backend.hosting_services.check_service module
    • ServiceChecker
      • ServiceChecker.activate_flag
      • ServiceChecker.config_file_path
      • ServiceChecker.create()
      • ServiceChecker.name_extractor
      • ServiceChecker.service_name
      • ServiceChecker.web_service_checker
  • cookiecutter_python.backend.hosting_services.check_web_hosting_service module
    • WebHostingServiceChecker
      • WebHostingServiceChecker.create()
      • WebHostingServiceChecker.url_getter
  • cookiecutter_python.backend.hosting_services.checker module
    • Checker
      • Checker.checkers
      • Checker.config_file
      • Checker.default_config
      • Checker.from_hosting_info()
  • cookiecutter_python.backend.hosting_services.checkers module
    • Checkers
      • Checkers.from_hosting_info()
  • cookiecutter_python.backend.hosting_services.exceptions module
    • ContextVariableDoesNotExist
  • cookiecutter_python.backend.hosting_services.extract_name module
    • NameExtractor
      • NameExtractor.create()
      • NameExtractor.name_extractor
  • cookiecutter_python.backend.hosting_services.handle_hosting_service_check module
    • CheckHostingServiceHandler
      • CheckHostingServiceHandler.check_hosting_service
      • CheckHostingServiceHandler.package_name
      • CheckHostingServiceHandler.service_name
  • cookiecutter_python.backend.hosting_services.handler module
    • CheckHostingServiceResultHandler
      • CheckHostingServiceResultHandler.is_future_response_200()
      • CheckHostingServiceResultHandler.service_name
    • Handlers
      • Handlers.from_checkers()
      • Handlers.handlers
  • cookiecutter_python.backend.hosting_services.value_extractor module
    • BaseValueExtractor
      • BaseValueExtractor.key_name
    • ValueExtractor
  • cookiecutter_python.backend.hosting_services.web_hosting_service module
    • HostingServiceInfo
      • HostingServiceInfo.create()
      • HostingServiceInfo.service
      • HostingServiceInfo.variable_name
    • HostingServices
      • HostingServices.subclasses
    • HostingServicesInfo
    • PyPIServerFactory
      • PyPIServerFactory.create()
      • PyPIServerFactory.variable_name
    • ReadTheDocsServerFactory
      • ReadTheDocsServerFactory.create()
      • ReadTheDocsServerFactory.variable_name
    • URLGetter
      • URLGetter.service_name
      • URLGetter.url_pattern
    • WebHostingService
      • WebHostingService.create()
      • WebHostingService.url
  • Module contents
    • Engine
      • Engine.check()
      • Engine.checker
      • Engine.config_file
      • Engine.create()
      • Engine.default_config
      • Engine.handle()
      • Engine.handlers
      • Engine.services_info
• cookiecutter_python.backend.sanitization package
  • Subpackages
    • cookiecutter_python.backend.sanitization.string_sanitizers package
      • Submodules
      • cookiecutter_python.backend.sanitization.string_sanitizers.base_sanitizer module
      • cookiecutter_python.backend.sanitization.string_sanitizers.sanitize_reg_input module
      • cookiecutter_python.backend.sanitization.string_sanitizers.sanitize_reg_module_name module
      • cookiecutter_python.backend.sanitization.string_sanitizers.sanitize_reg_version module
      • Module contents
  • Submodules
  • cookiecutter_python.backend.sanitization.input_sanitization module
    • Sanitize
      • Sanitize.exceptions
      • Sanitize.exceptions_map
      • Sanitize.register_exception()
      • Sanitize.register_sanitizer()
      • Sanitize.sanitizers_map
  • cookiecutter_python.backend.sanitization.interpreters_support module
    • InvalidInterpretersError
    • unsupported_interpreters()
    • verify_input_interpreters()
  • Module contents

Submodules

cookiecutter_python.backend.check_server_result module

class cookiecutter_python.backend.check_server_result.CheckWebServerResult

Bases: ABC

Interface for checking the result of a web server request.

abstract property future

abstract property name: str

The name of the resource requested to search on the web server.

Returns:

the name of the resource (ie python package slug, rtd project)

Return type:

str

abstract property service_name: str

The name of the web server.

Returns:

the name (slug) of the web server

Return type:

str

cookiecutter_python.backend.gen_docs_common module

Internal configuration for Documentation Generation.

cookiecutter_python.backend.gen_docs_common.get_docs_gen_internal_config() → Dict[str, str]

Derive the internal configuration for Documentation Generation.

Information included:

• the folder where we each docs builder will generate the docs. We locate the template folder for each docs builder, which is the Single Source of Truth for the docs builder’s output folder.

cookiecutter_python.backend.helpers module

cookiecutter_python.backend.helpers.parse_context(config_file: str)

cookiecutter_python.backend.load_config module

exception cookiecutter_python.backend.load_config.InvalidYamlFormatError

Bases: Exception

exception cookiecutter_python.backend.load_config.UserYamlDesignError

Bases: Exception

cookiecutter_python.backend.load_config.get_interpreters_from_yaml(config_file: str) → Mapping[str, Sequence[str]] | None

Parse the ‘interpreters’ variable out of the user’s config yaml file.

Parameters:

config_file (str) – path to the user’s config yaml file

Raises:

• InvalidYamlFormatError – if yaml parser fails to load the user’s config

• UserYamlDesignError – if yaml does not contain the ‘default_context’ key

Returns:

dictionary with intepreters as a sequence of strings,

mapped to the ‘supported-interpreters’ key

Return type:

GivenInterpreters

cookiecutter_python.backend.load_config.load_yaml(config_file) → MutableMapping

cookiecutter_python.backend.main module

cookiecutter_python.backend.main.generate(no_input=False, offline=False, extra_context=None, replay=False, overwrite=False, output_dir='.', config_file=None, skip_if_file_exists=False, default_config=False, password=None, directory=None, checkout=None) → str

Create Python Project, with CI/CD pipeline, from the project template.

Generate/Scaffold a new Python Project, including configuration enabling automations such as CI and Continuous Delivery of Docker and Python ‘artifacts’, and Continuous Documentation of the Python Project.

cookiecutter_python.backend.post_main module

exception cookiecutter_python.backend.post_main.CheckWebServerError

Bases: Exception

Raised on Connection Error, when Requesting a Web Server’s Future.

cookiecutter_python.backend.post_main.post_main(request)

Check if any CI ‘deployment’ (ie in pypi), would require minor tweak.

cookiecutter_python.backend.pre_main module

cookiecutter_python.backend.pre_main.pre_main(request)

Do preparatory steps Generation process, by settings things as the Template Context.

Parameters:

**kwargs – Arbitrary keyword arguments.

cookiecutter_python.backend.proxy module

class cookiecutter_python.backend.proxy.BaseProxy(proxy_subject: ProxySubject)

Bases: Proxy[T], Generic[T]

static log_info_args(message: str, *args, **kwargs) → Tuple[str, str]

cookiecutter_python.backend.request module

class cookiecutter_python.backend.request.Request(*, config_file: str, default_config: bool, web_servers: List[str], no_input: bool, extra_context: dict, check: Any | None = None, check_results: None | Iterable[CheckWebServerResult] = None, offline: bool = False)

Bases: object

check: Any

check_results: None | Iterable[CheckWebServerResult]

config_file: str

default_config: bool

extra_context: dict

no_input: bool

offline: bool

web_servers: List[str]

cookiecutter_python.backend.user_config_proxy module

Module contents

exception cookiecutter_python.backend.CheckWebServerError

Bases: Exception

Raised on Connection Error, when Requesting a Web Server’s Future.

cookiecutter_python.backend.generate(no_input=False, offline=False, extra_context=None, replay=False, overwrite=False, output_dir='.', config_file=None, skip_if_file_exists=False, default_config=False, password=None, directory=None, checkout=None) → str

Create Python Project, with CI/CD pipeline, from the project template.

Generate/Scaffold a new Python Project, including configuration enabling automations such as CI and Continuous Delivery of Docker and Python ‘artifacts’, and Continuous Documentation of the Python Project.

cookiecutter_python.backend.get_docs_gen_internal_config() → Dict[str, str]

Derive the internal configuration for Documentation Generation.

Information included:

• the folder where we each docs builder will generate the docs. We locate the template folder for each docs builder, which is the Single Source of Truth for the docs builder’s output folder.