Auto-generated index

Author: github-actions[bot]

docs/_index/.metadata

@@ -0,0 +1 @@
+{"name": "argumentation", "metadata": {"name": "argumentation", "version": "0.1.0", "classifiers": [], "home_page": null, "license": null, "documentation_url": null, "dependencies": ["pydantic", "pyyaml"], "summary": "Python argument parser for complex applications", "upload_time": 1740579689}, "documentation": ["# Argumentation\nArgumentation is a Python library that bridges Pydantic models with argparse to create robust, type-safe command-line interfaces with minimal boilerplate. Define your application's configuration using Pydantic models, and Argumentation handles the command-line parsing, validation, and configuration file loading automatically.\n\n## Features\n- Type-safe Configuration: Utilize Pydantic's validation system for command-line arguments\n- Configuration Files: Support for TOML, YAML, and JSON configuration files\n- Automatic CLI Generation: Convert your Pydantic models into command-line interfaces automatically\n- Rich Type Support: Handles complex types including:\n    - Basic types (bool, int, float, str)\n    - Lists and tuples\n    - Literal types with choices\n    - Union types\n    - Custom Pydantic models\n\n## Installation\n1. uv (recommended)\n```bash\nuv add argumentation\n```\n2. poetry\n```bash\npoetry add argumentation\n```\n3. pip\n```bash\npip install argumentation\n```\n\n## Usage\n\n1. Create your configuration model using the ArgumentationModel\n1. Create your main function which takes the configuration as an argument\n1. Call the argumentation.run function with your main function\n\nSee `examples/simple.py` for more details\n\n```bash\npython examples/simple.py --name \"My Application\" --debug --port 5000 --hosts localhost 127.0.0.1\n```\n\n### Configuration Files\n\nArgumentation supports loading configuration from TOML, YAML, and JSON files.\n```bash\npython examples/config.py --config examples/config.yaml\n```\n\nYou can also override configuration file values from the command line.\n```bash\npython examples/simple.py --config examples/config.yaml --port 8888\n```\n\n## License\n\nArgumentation is licensed under the MIT License. See the LICENSE file for details."], "modules": [{"name": "argumentation", "documentation": [], "functions": [{"name": "argumentation.partial_model", "asynchronous": false, "params": [{"name": "model", "type": {"name": "Type", "xref": {"fqname": "typing.Type", "project": "--std--"}, "params": [{"name": "BaseModel", "xref": {"fqname": "pydantic.BaseModel", "project": "pydantic"}, "params": null}]}, "default": null}], "returns": {"name": "type", "xref": {"fqname": "functions.type", "project": "--std--"}, "params": [{"name": "BaseModel", "xref": {"fqname": "pydantic.BaseModel", "project": "pydantic"}, "params": null}]}, "documentation": []}, {"name": "argumentation.add_arg", "asynchronous": false, "params": [{"name": "arg_parser", "type": null, "default": null}, {"name": "config", "type": null, "default": null}, {"name": "config_path", "type": null, "default": null}, {"name": "arg_name", "type": null, "default": null}, {"name": "arg_type", "type": null, "default": null}, {"name": "arg_kwargs", "type": null, "default": null}], "returns": null, "documentation": []}], "variables": [], "classes": [{"name": "argumentation.NoopAction", "bases": ["argparse.Action"], "methods": [{"name": "argumentation.NoopAction.__call__", "asynchronous": false, "params": [{"name": "self", "type": null, "default": null}, {"name": "parser", "type": null, "default": null}, {"name": "namespace", "type": null, "default": null}, {"name": "values", "type": null, "default": null}, {"name": "option_string", "type": null, "default": "..."}], "returns": null, "documentation": []}], "class_variables": [], "instance_variables": [], "inner_classes": [], "documentation": []}, {"name": "argumentation.ConfigFileAction", "bases": ["argparse.Action"], "methods": [{"name": "argumentation.ConfigFileAction.__call__", "asynchronous": false, "params": [{"name": "self", "type": null, "default": null}, {"name": "parser", "type": null, "default": null}, {"name": "namespace", "type": null, "default": null}, {"name": "values", "type": null, "default": null}, {"name": "option_string", "type": null, "default": "..."}], "returns": null, "documentation": []}], "class_variables": [], "instance_variables": [], "inner_classes": [], "documentation": []}, {"name": "argumentation.ArgumentationModel", "bases": ["BaseModel"], "methods": [], "class_variables": [{"name": "argumentation.ArgumentationModel.model_config", "type": null, "documentation": []}], "instance_variables": [], "inner_classes": [], "documentation": []}, {"name": "argumentation.Argumentation", "bases": [], "methods": [{"name": "argumentation.Argumentation.run", "asynchronous": false, "params": [{"name": "func", "type": {"name": "callable", "xref": {"fqname": "functions.callable", "project": "--std--"}, "params": null}, "default": null}, {"name": "*args", "type": null, "default": null}, {"name": "**kwargs", "type": null, "default": null}], "returns": null, "documentation": []}], "class_variables": [{"name": "argumentation.Argumentation.description", "type": {"name": "str", "xref": {"fqname": "functions.str", "project": "--std--"}, "params": null}, "documentation": []}], "instance_variables": [], "inner_classes": [], "documentation": []}], "exports": [{"name": "argumentation.Any", "xref": {"fqname": "typing.Any", "project": null}}, {"name": "argumentation.ArgumentParser", "xref": {"fqname": "argparse.ArgumentParser", "project": null}}, {"name": "argumentation.BaseModel", "xref": {"fqname": "pydantic.BaseModel", "project": "pydantic"}}, {"name": "argumentation.ConfigDict", "xref": {"fqname": "pydantic.ConfigDict", "project": "pydantic"}}, {"name": "argumentation.create_model", "xref": {"fqname": "pydantic.create_model", "project": "pydantic"}}, {"name": "argumentation.dataclass", "xref": {"fqname": "dataclasses.dataclass", "project": null}}, {"name": "argumentation.deepcopy", "xref": {"fqname": "copy.deepcopy", "project": null}}, {"name": "argumentation.FieldInfo", "xref": {"fqname": "pydantic.fields.FieldInfo", "project": "pydantic"}}, {"name": "argumentation.GenericAlias", "xref": {"fqname": "types.GenericAlias", "project": null}}, {"name": "argumentation.get_args", "xref": {"fqname": "typing.get_args", "project": null}}, {"name": "argumentation.get_origin", "xref": {"fqname": "typing.get_origin", "project": null}}, {"name": "argumentation.isclass", "xref": {"fqname": "inspect.isclass", "project": null}}, {"name": "argumentation.Literal", "xref": {"fqname": "typing.Literal", "project": null}}, {"name": "argumentation.Optional", "xref": {"fqname": "typing.Optional", "project": null}}, {"name": "argumentation.signature", "xref": {"fqname": "inspect.signature", "project": null}}, {"name": "argumentation.Tuple", "xref": {"fqname": "typing.Tuple", "project": null}}, {"name": "argumentation.Type", "xref": {"fqname": "typing.Type", "project": null}}, {"name": "argumentation.Union", "xref": {"fqname": "typing.Union", "project": null}}, {"name": "argumentation.ValidationError", "xref": {"fqname": "pydantic.ValidationError", "project": "pydantic"}}]}]}

docs/_index/argumentation.json

@@ -0,0 +1 @@
+{"name": "bda-flask-middleware", "metadata": {"name": "bda-flask-middleware", "version": "0.1.0", "classifiers": ["Operating System :: OS Independent", "Programming Language :: Python :: 3"], "home_page": "https://github.com/irfan4002/flask-middleware", "license": "unlicense", "documentation_url": null, "dependencies": [], "summary": "A custom middleware library", "upload_time": 1740577984}, "documentation": ["# My Middleware Library\r\n\r\nThis is a custom middleware library for web applications.\r\n\r\n## Installation\r\n\r\n```bash\r\npip install flask-middleware\r\n"], "modules": [{"name": "bda_flask_middleware", "documentation": [], "functions": [], "variables": [], "classes": [], "exports": [{"name": "bda_flask_middleware.FlaskAppResponseMiddleware", "xref": {"fqname": "bda_flask_middleware.flasktest.FlaskAppResponseMiddleware", "project": null}}]}, {"name": "bda_flask_middleware.flasktest", "documentation": [], "functions": [], "variables": [], "classes": [{"name": "bda_flask_middleware.flasktest.FlaskAppResponseMiddleware", "bases": ["object"], "methods": [{"name": "bda_flask_middleware.flasktest.FlaskAppResponseMiddleware.__init__", "asynchronous": false, "params": [{"name": "self", "type": null, "default": null}], "returns": null, "documentation": []}, {"name": "bda_flask_middleware.flasktest.FlaskAppResponseMiddleware.process_request", "asynchronous": false, "params": [{"name": "self", "type": null, "default": null}, {"name": "request", "type": null, "default": null}, {"name": "spider", "type": null, "default": null}], "returns": null, "documentation": []}], "class_variables": [], "instance_variables": [], "inner_classes": [], "documentation": []}], "exports": []}]}

docs/_index/b3dv.json

@@ -0,0 +1 @@
+{"name": "bugx", "metadata": {"name": "bugx", "version": "0.1.1", "classifiers": [], "home_page": null, "license": null, "documentation_url": null, "dependencies": ["hatch", "inquirerpy", "prettytable", "typer"], "summary": "Bug Report extractor", "upload_time": 1740580886}, "documentation": ["#### Bugreport Extractor"], "modules": [{"name": "bugx.__main__", "documentation": [], "functions": [{"name": "bugx.__main__.app", "asynchronous": false, "params": [], "returns": null, "documentation": []}], "variables": [], "classes": [], "exports": []}, {"name": "bugx.__about__", "documentation": ["About "], "functions": [], "variables": [{"name": "bugx.__about__.__version__", "type": null, "documentation": []}, {"name": "bugx.__about__.__author__", "type": null, "documentation": []}], "classes": [], "exports": []}, {"name": "bugx.cli", "documentation": [], "functions": [{"name": "bugx.cli.main", "asynchronous": false, "params": [], "returns": null, "documentation": []}], "variables": [], "classes": [], "exports": []}, {"name": "bugx", "documentation": [], "functions": [], "variables": [], "classes": [], "exports": []}, {"name": "bugx.bugreport_extractor", "documentation": ["Bugreport extractor"], "functions": [{"name": "bugx.bugreport_extractor.pattern_builder", "asynchronous": false, "params": [{"name": "dir_name", "type": {"name": "str", "xref": {"fqname": "functions.str", "project": "--std--"}, "params": null}, "default": null}, {"name": "patterns", "type": {"name": "set", "xref": {"fqname": "functions.set", "project": "--std--"}, "params": [{"name": "str", "xref": {"fqname": "functions.str", "project": "--std--"}, "params": null}]}, "default": null}], "returns": {"name": "set", "xref": {"fqname": "functions.set", "project": "--std--"}, "params": [{"name": "str", "xref": {"fqname": "functions.str", "project": "--std--"}, "params": null}]}, "documentation": ["Generates the file patterns\n\nArgs:\n    dir_path (str): Directory Name\n    patterns (set[str]) file patterns for matching\n\nReturns:\n    set[str]: set of path with file patterns"]}, {"name": "bugx.bugreport_extractor.get_bugreports", "asynchronous": false, "params": [{"name": "dir_name", "type": {"name": "str", "xref": {"fqname": "functions.str", "project": "--std--"}, "params": null}, "default": null}], "returns": {"name": "list", "xref": {"fqname": "functions.list", "project": "--std--"}, "params": [{"name": "str", "xref": {"fqname": "functions.str", "project": "--std--"}, "params": null}]}, "documentation": ["Fetches the list of bugreports\n\nArgs:\n    dir_name (str): Name of directory for lookup.\n\nReturns:\n    list[str]: List of the bugreports sorted in recent order."]}, {"name": "bugx.bugreport_extractor.select_bugreport", "asynchronous": false, "params": [{"name": "dir_name", "type": {"name": "str", "xref": {"fqname": "functions.str", "project": "--std--"}, "params": null}, "default": null}], "returns": {"name": "Union", "xref": {"fqname": "typing.Union", "project": "--std--"}, "params": [{"name": "List", "xref": {"fqname": "typing.List", "project": "--std--"}, "params": [{"name": "str", "xref": {"fqname": "functions.str", "project": "--std--"}, "params": null}]}, {"name": "str", "xref": {"fqname": "functions.str", "project": "--std--"}, "params": null}]}, "documentation": ["Prompt the user for selection.\n\nArgs:\n    dir_name (str): Directory name for file lookup.\n\nReturns:\n    Union[List[str], str]: List of selected bugreports."]}, {"name": "bugx.bugreport_extractor._parse_file", "asynchronous": false, "params": [{"name": "file_path", "type": {"name": "str", "xref": {"fqname": "functions.str", "project": "--std--"}, "params": null}, "default": null}], "returns": {"name": "tuple", "xref": {"fqname": "functions.tuple", "project": "--std--"}, "params": [{"name": "str", "xref": {"fqname": "functions.str", "project": "--std--"}, "params": null}, {"name": "str", "xref": {"fqname": "functions.str", "project": "--std--"}, "params": null}]}, "documentation": ["parses the zip/gz files\n\nArgs:\n    file_path (str): zip/gz file path."]}, {"name": "bugx.bugreport_extractor._handle_device_info", "asynchronous": false, "params": [{"name": "info_txt", "type": {"name": "str", "xref": {"fqname": "functions.str", "project": "--std--"}, "params": null}, "default": null}], "returns": {"name": "dict", "xref": {"fqname": "functions.dict", "project": "--std--"}, "params": null}, "documentation": ["Fetches device info from the dumpstate text.\n\nArgs:\n    info_txt (str): dumpstate text.\n\nReturns:\n    dict: device info."]}, {"name": "bugx.bugreport_extractor._handle_other_info", "asynchronous": false, "params": [{"name": "info_txt", "type": {"name": "str", "xref": {"fqname": "functions.str", "project": "--std--"}, "params": null}, "default": null}], "returns": {"name": "dict", "xref": {"fqname": "functions.dict", "project": "--std--"}, "params": null}, "documentation": ["Fetches other info from the dumpstate text.\n\nArgs:\n    info_txt (str): dumpstate text.\n\nReturns:\n    dict: other info."]}, {"name": "bugx.bugreport_extractor._handle_packages", "asynchronous": false, "params": [{"name": "info_txt", "type": {"name": "str", "xref": {"fqname": "functions.str", "project": "--std--"}, "params": null}, "default": null}], "returns": {"name": "list", "xref": {"fqname": "functions.list", "project": "--std--"}, "params": [{"name": "dict", "xref": {"fqname": "functions.dict", "project": "--std--"}, "params": [{"name": "str", "xref": {"fqname": "functions.str", "project": "--std--"}, "params": null}, {"name": "Union", "xref": {"fqname": "typing.Union", "project": "--std--"}, "params": [{"name": "str", "xref": {"fqname": "functions.str", "project": "--std--"}, "params": null}, {"name": "Any", "xref": {"fqname": "typing.Any", "project": "--std--"}, "params": null}]}]}]}, "documentation": ["Fetches the package name, version name, version code and last updatetime.\n\nArgs:\n    info_txt (str): dumpstate text\n\nReturns:\n    list[dict[str, Union[str, Any]]]: package list."]}, {"name": "bugx.bugreport_extractor._generate_files", "asynchronous": false, "params": [{"name": "dumpstate_text", "type": {"name": "str", "xref": {"fqname": "functions.str", "project": "--std--"}, "params": null}, "default": null}, {"name": "parsed_output_text", "type": {"name": "str", "xref": {"fqname": "functions.str", "project": "--std--"}, "params": null}, "default": null}, {"name": "file_name", "type": {"name": "str", "xref": {"fqname": "functions.str", "project": "--std--"}, "params": null}, "default": null}], "returns": null, "documentation": ["Generates the rawbugreport and packageversion text files.\n\nArgs:\n    dumpstate_text (str): dumpstate text.\n    parsed_output_text (str): text after parsing the raw dumpstate text.\n    file_name (str): file name to be stored."]}, {"name": "bugx.bugreport_extractor.parse_bugreport", "asynchronous": false, "params": [{"name": "file_path", "type": {"name": "str", "xref": {"fqname": "functions.str", "project": "--std--"}, "params": null}, "default": null}], "returns": {"name": "None", "xref": {"fqname": "constants.None", "project": "--std--"}, "params": null}, "documentation": ["Parses the bugreport file\n\nArgs:\n    file_path (str): file path."]}], "variables": [{"name": "bugx.bugreport_extractor.console", "type": null, "documentation": []}, {"name": "bugx.bugreport_extractor.HOME", "type": {"name": "str", "xref": {"fqname": "functions.str", "project": "--std--"}, "params": null}, "documentation": []}, {"name": "bugx.bugreport_extractor.DOWNLOADS", "type": {"name": "str", "xref": {"fqname": "functions.str", "project": "--std--"}, "params": null}, "documentation": []}, {"name": "bugx.bugreport_extractor.BUGREPORT_FILE_PATTERNS", "type": {"name": "set", "xref": {"fqname": "functions.set", "project": "--std--"}, "params": [{"name": "str", "xref": {"fqname": "functions.str", "project": "--std--"}, "params": null}]}, "documentation": []}, {"name": "bugx.bugreport_extractor.CLI_HEADER", "type": null, "documentation": []}, {"name": "bugx.bugreport_extractor.CLI_HEADER_1", "type": null, "documentation": []}, {"name": "bugx.bugreport_extractor.PACKAGE_PATTERN", "type": null, "documentation": []}, {"name": "bugx.bugreport_extractor.VERSION_NAME_PATTERN", "type": null, "documentation": []}, {"name": "bugx.bugreport_extractor.VERSION_CODE_PATTERN", "type": null, "documentation": []}, {"name": "bugx.bugreport_extractor.LAST_UPDATE_TIME_PATTERN", "type": null, "documentation": []}, {"name": "bugx.bugreport_extractor.TIME_ZONE_PATTERN", "type": null, "documentation": []}, {"name": "bugx.bugreport_extractor.device_info_patterns", "type": {"name": "dict", "xref": {"fqname": "functions.dict", "project": "--std--"}, "params": [{"name": "str", "xref": {"fqname": "functions.str", "project": "--std--"}, "params": null}, {"name": "Pattern", "xref": {"fqname": "re.Pattern", "project": "--std--"}, "params": [{"name": "str", "xref": {"fqname": "functions.str", "project": "--std--"}, "params": null}]}]}, "documentation": []}, {"name": "bugx.bugreport_extractor.other_info_patterns", "type": {"name": "dict", "xref": {"fqname": "functions.dict", "project": "--std--"}, "params": [{"name": "str", "xref": {"fqname": "functions.str", "project": "--std--"}, "params": null}, {"name": "Pattern", "xref": {"fqname": "re.Pattern", "project": "--std--"}, "params": [{"name": "str", "xref": {"fqname": "functions.str", "project": "--std--"}, "params": null}]}]}, "documentation": []}, {"name": "bugx.bugreport_extractor.bugreports", "type": {"name": "list", "xref": {"fqname": "functions.list", "project": "--std--"}, "params": [{"name": "str", "xref": {"fqname": "functions.str", "project": "--std--"}, "params": null}]}, "documentation": []}, {"name": "bugx.bugreport_extractor.files", "type": {"name": "List[str] | str", "xref": null, "params": null}, "documentation": []}], "classes": [], "exports": []}]}

docs/_index/bda-flask-middleware.json

@@ -0,0 +1 @@
+{"name": "dal-pdf-creator", "metadata": {"name": "dal-pdf-creator", "version": "0.0.2", "classifiers": ["Development Status :: 3 - Alpha", "Intended Audience :: Education", "Operating System :: MacOS :: MacOS X", "Operating System :: Microsoft :: Windows", "Programming Language :: Python :: 2", "Programming Language :: Python :: 3"], "home_page": null, "license": null, "documentation_url": null, "dependencies": ["fpdf2", "yta-general-utils"], "summary": "PDF Creator", "upload_time": 1740579972}, "documentation": ["Library to play with PDFs and generate them\n\n\n"], "modules": [{"name": "dal_pdf_creator", "documentation": ["This library will make the PDF\ncreation process very easy."], "functions": [], "variables": [], "classes": [], "exports": []}]}