{"id":19045327,"url":"https://github.com/vandenberghinc/dev0s","last_synced_at":"2026-05-07T09:31:33.440Z","repository":{"id":62567843,"uuid":"345804885","full_name":"vandenberghinc/dev0s","owner":"vandenberghinc","description":"DevOS library (python, bash \u0026 javascript).","archived":false,"fork":false,"pushed_at":"2021-12-19T03:44:49.000Z","size":23158,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-09-25T02:40:56.832Z","etag":null,"topics":["bash","dev0s","javascript","js","python3"],"latest_commit_sha":null,"homepage":"https://api.vandenberghinc.com/docs/dev0s","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/vandenberghinc.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-03-08T21:49:51.000Z","updated_at":"2021-12-19T03:44:52.000Z","dependencies_parsed_at":"2022-11-03T17:00:42.412Z","dependency_job_id":null,"html_url":"https://github.com/vandenberghinc/dev0s","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/vandenberghinc/dev0s","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vandenberghinc%2Fdev0s","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vandenberghinc%2Fdev0s/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vandenberghinc%2Fdev0s/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vandenberghinc%2Fdev0s/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/vandenberghinc","download_url":"https://codeload.github.com/vandenberghinc/dev0s/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vandenberghinc%2Fdev0s/sbom","scorecard":{"id":915783,"data":{"date":"2025-08-11","repo":{"name":"github.com/vandenberghinc/dev0s","commit":"1c9629e2a81ad111fd3e74929aaeb05c97be0276"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":2.3,"checks":[{"name":"Dangerous-Workflow","score":-1,"reason":"no workflows found","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Token-Permissions","score":-1,"reason":"No tokens found","details":null,"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Code-Review","score":0,"reason":"Found 0/30 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Binary-Artifacts","score":6,"reason":"binaries present in source code","details":["Warn: binary detected: dev0s/classes/system/drivers/linux/chromedriver:1","Warn: binary detected: dev0s/classes/system/drivers/linux/geckodriver:1","Warn: binary detected: dev0s/classes/system/drivers/macos/chromedriver:1","Warn: binary detected: dev0s/classes/system/drivers/macos/geckodriver:1"],"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"SAST","score":0,"reason":"no SAST tool detected","details":["Warn: no pull requests merged into dev branch"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Vulnerabilities","score":10,"reason":"0 existing vulnerabilities detected","details":null,"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE.txt:0","Info: FSF or OSI recognized license: MIT License: LICENSE.txt:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'master'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"Pinned-Dependencies","score":0,"reason":"dependency not pinned by hash detected -- score normalized to 0","details":["Warn: downloadThenRun not pinned by hash: dev0s/lib/bash/import:120","Warn: pipCommand not pinned by hash: dev0s/lib/bash/utils:270","Info:   0 out of   1 downloadThenRun dependencies pinned","Info:   0 out of   1 pipCommand dependencies pinned"],"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}}]},"last_synced_at":"2025-08-24T20:55:32.968Z","repository_id":62567843,"created_at":"2025-08-24T20:55:32.968Z","updated_at":"2025-08-24T20:55:32.968Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32731217,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-07T02:14:30.463Z","status":"ssl_error","status_checked_at":"2026-05-07T02:14:29.405Z","response_time":62,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bash","dev0s","javascript","js","python3"],"created_at":"2024-11-08T22:49:51.536Z","updated_at":"2026-05-07T09:31:33.420Z","avatar_url":"https://github.com/vandenberghinc.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# dev0s\nAuthor(s):  Daan van den Bergh.\u003cbr\u003e\nCopyright:  © 2020 Daan van den Bergh All Rights Reserved.\u003cbr\u003e\nSupported Operating Systems: macos \u0026 linux.\u003cbr\u003e\n\u003cbr\u003e\n\u003cbr\u003e\n\u003cp align=\"center\"\u003e\n  \u003cimg src=\"https://raw.githubusercontent.com/vandenberghinc/public-storage/master/vandenberghinc/icon/icon.png\" alt=\"Bergh-Encryption\" width=\"50\"\u003e \n\u003c/p\u003e\n\n## Table of content:\n  * [Description](#description)\n  * [Installation](#installation)\n  * [Troubleshooting.](#troubleshooting.)\n  * [Custom Code Examples.](#custom-code-examples.)\n  * [Code Examples](#code-examples)\n\n# Description:\nDevOS library.\n\n# Installation:\nInstall the package.\n\n\tcurl -s https://raw.githubusercontent.com/vandenberghinc/dev0s/master/dev0s/requirements/installer.remote | bash \n\n# Troubleshooting.\n\n### Broken pip3.\n\tcurl https://bootstrap.pypa.io/get-pip.py -o get-pip.py \u0026\u0026 python3 get-pip.py --force-reinstall --user $USER \u0026\u0026 pip3 install six\n\n# Custom Code Examples.\n\n#### dev0s.response usage.\nAn example function that returns a ResponseObject class.\n\n```python\n\n# import the package\nfrom dev0s.shortcuts import *\n\n# universal responses.\ndef my_function():\n\n\t# return an error response from a function.\n\treturn dev0s.response.error(\"Failed to retrieve your personal API key\")\n\n\t# return a success response from a function.\n\treturn dev0s.response.success(\"Success retrieved your personal API key\", {\n\t\t\"api_key\":api_key,\n\t})\n\n# check if a response was successfull.\nresponse = my_function()\nif response.success:\n\tmessage = response[\"message\"]\nelse:\n\terror = response[\"error\"]\n\n```\n\n#### dev0s.cli.CLI Usage.\n\n##### Simple Example.\n\nSimple CLI.CLI code example.\n\n```python\n# the cli object class.\nclass CLI(dev0s.cli.CLI):\n\tdef __init__(self):\n\t\t\n\t\t# defaults.\n\t\tdev0s.cli.CLI.__init__(self,\n\t\t\tmodes={\n\t\t\t\t\"--config\":\"Edit the ssht00ls configuration file (nano).\",\n\t\t\t\t\"-h / --help\":\"Show the documentation.\",\n\t\t\t},\n\t\t\talias=\"ssht00ls\",\n\t\t\texecutable=__file__,\n\t\t)\n\n\t\t#\n\tdef start(self):\n\t\t\n\t\t# check arguments.\n\t\tself.arguments.check()\n\n\t\t# help.\n\t\tif self.arguments.present(['-h', '--help']):\n\t\t\tself.docs(success=True)\n\n\t\t# config.\n\t\telif self.arguments.present('--config'):\n\t\t\tos.system(f\"nano {CONFIG.file_path.path}\")\n\n\t\t# invalid.\n\t\telse: self.invalid()\n\n\t\t#\n\n# main.\nif __name__ == \"__main__\":\n\tcli = CLI()\n\tcli.start()\n```\n\n##### Advanced Example.\n\nAdvanced CLI.CLI code example.\n\n```python\n#!/usr/bin/env python3\n# -*- coding: utf-8 -*-\n\n# imports.\nfrom dev0s.shortcuts import * ; dev0s.defaults.insert(dev0s.defaults.source_path(__file__, back=2))\nfrom ssht00ls.classes.config import *\nimport ssht00ls\n\n# the cli object class.\nclass CLI(dev0s.cli.CLI):\n\tdef __init__(self):\n\t\t\n\t\t# defaults.\n\t\tdev0s.cli.CLI.__init__(self,\n\t\t\tmodes={\n\t\t\t\t\"Aliases:\":\"*chapter*\",\n\t\t\t\t\"    --create-alias\":\"Create a ssh alias.\",\n\t\t\t\t\"        --server myserver\":\"Specify the server's name.\",\n\t\t\t\t\"        --username myuser\":\"Specify the username.\",\n\t\t\t\t\"        --ip 0.0.0.0\":\"Specify the server's ip.\",\n\t\t\t\t\"        --port 22\":\"Specify the server's port.\",\n\t\t\t\t\"        for ssh keys:\":\"\",\n\t\t\t\t\"        --key /path/to/key/private_key\":\"Specify the path to the private key.\",\n\t\t\t\t\"        --passphrase 'MyPassphrase123'\":\"Specify the keys pasphrase (optional).\",\n\t\t\t\t\"        for smart cards:\":\"\",\n\t\t\t\t\"        --smart-cards\":\"Enable the smart cards boolean.\",\n\t\t\t\t\"        --pin 123456\":\"Specify the smart cards pin code (optional).\",\n\t\t\t\t\"Keys:\":\"*chapter*\",\n\t\t\t\t\"    --generate\":\"Generate a ssh key.\",\n\t\t\t\t\"        --path /keys/mykey/\":\"Specify the keys directory path.\",\n\t\t\t\t\"        --passphrase Passphrase123\":\"Specify the keys passphrase.\",\n\t\t\t\t\"        --comment 'My Key'\":\"Specify the keys comment.\",\n\t\t\t\t\"Sessions:\":\"*chapter*\",\n\t\t\t\t\"    --command \u003calias\u003e 'ls .'\":\"Execute a command over ssh.\",\n\t\t\t\t\"    --session \u003calias\u003e\":\"Start a ssh session.\",\n\t\t\t\t\"        --options '' \":\"Specify additional ssh options (optional).\",\n\t\t\t\t\"Push \u0026 pull:\":\"*chapter*\",\n\t\t\t\t\"    --pull \u003cpath\u003e \u003calias\u003e:\u003cremote\u003e\":\"Pull a file / directory.\",\n\t\t\t\t\"        --delete\":\"Also update the deleted files (optional).\",\n\t\t\t\t\"        --safe\":\"Enable version control.\",\n\t\t\t\t\"        --forced\":\"Enable forced mode.\",\n\t\t\t\t\"    --push \u003calias\u003e:\u003cremote\u003e \u003cpath\u003e\":\"Push a file / directory.\",\n\t\t\t\t\"        --delete\":\"Also update the deleted files (optional).\",\n\t\t\t\t\"        --safe\":\"Enable version control.\",\n\t\t\t\t\"        --forced\":\"Enable forced mode.\",\n\t\t\t\t\"Mounts:\":\"*chapter*\",\n\t\t\t\t\"    --mount \u003calias\u003e:\u003cremote\u003e \u003cpath\u003e\":\"Mount a remote directory.\",\n\t\t\t\t\"    --unmount \u003cpath\u003e\":\"Unmount a mounted remote directory.\",\n\t\t\t\t\"        --sudo\":\"Root permission required.\",\n\t\t\t\t\"        --forced\":\"Enable forced mode.\",\n\t\t\t\t\"    --index \u003cpath\u003e / \u003calias\u003e:\u003cremote\u003e\":\"Index the specified path / alias:remote.\",\n\t\t\t\t\"Agent:\":\"*chapter*\",\n\t\t\t\t\"    --start-agent\":\"Start the ssht00ls agent manually.\",\n\t\t\t\t\"    --stop-agent\":\"Stop the ssht00ls agent.\",\n\t\t\t\t\"Daemons:\":\"*chapter*\",\n\t\t\t\t\"    --start-daemon \u003calias\u003e:\u003cremote\u003e \u003cpath\u003e\":\"Start a ssync daemon manually.\",\n\t\t\t\t\"    --stop-daemon \u003cpath\u003e\":\"Stop a ssync daemon.\",\n\t\t\t\t\"Basic:\":\"*chapter*\",\n\t\t\t\t\"    --kill \u003cidentifier\u003e\":\"Kill all ssh processes that include the identifier.\",\n\t\t\t\t\"    --config\":\"Edit the ssht00ls configuration file (nano).\",\n\t\t\t\t\"    -h / --help\":\"Show the documentation.\",\n\t\t\t},\n\t\t\toptions={\n\t\t\t\t\"-j / --json\":\"Print the response in json format.\",\n\t\t\t},\n\t\t\tnotes={\n\t\t\t\t\"SSHT00LS_CONFIG\":\"Specify the $SSHT00LS_CONFIG environment variable to use a different ssht00ls config file.\",\n\t\t\t},\n\t\t\talias=ALIAS,\n\t\t\texecutable=__file__,\n\t\t)\n\n\t\t#\n\tdef start(self):\n\t\t\n\t\t# check arguments.\n\t\tself.arguments.check(exceptions=[\"--log-level\", \"--create-alias\"], json=JSON)\n\n\t\t# help.\n\t\tif self.arguments.present(['-h', '--help']):\n\t\t\tself.docs(success=True, json=JSON)\n\n\t\t# check create ssh config.\n\t\telif self.arguments.present('--create-alias'):\n\t\t\t\n\t\t\t# create an ssh alias for the key.\n\t\t\tif not self.arguments.present('--smart-card'):\n\t\t\t\tkey = self.arguments.get('--key')\n\t\t\t\tresponse = ssht00ls.aliases.create( \n\t\t\t\t\t# the alias.\n\t\t\t\t\talias=self.arguments.get('--alias', chapter=\"aliases\", mode=\"--create-alias\"), \n\t\t\t\t\t# the username.\n\t\t\t\t\tusername=self.arguments.get('--username'), chapter=\"aliases\", mode=\"--create-alias\", \n\t\t\t\t\t# the public ip of the server.\n\t\t\t\t\tpublic_ip=self.arguments.get('--public-ip', chapter=\"aliases\", mode=\"--create-alias\"),\n\t\t\t\t\t# the public port of the server.\n\t\t\t\t\tpublic_port=self.arguments.get('--public-port', chapter=\"aliases\", mode=\"--create-alias\"),\n\t\t\t\t\t# the private ip of the server.\n\t\t\t\t\tprivate_ip=self.arguments.get('--private-ip', chapter=\"aliases\", mode=\"--create-alias\"),\n\t\t\t\t\t# the private port of the server.\n\t\t\t\t\tprivate_port=self.arguments.get('--private-port', chapter=\"aliases\", mode=\"--create-alias\"),\n\t\t\t\t\t# the path to the private key.\n\t\t\t\t\tkey=key,\n\t\t\t\t\tpassphrase=getpass.getpass(\"Enter the passphrase of key [{key}]:\"),\n\t\t\t\t\t# smart card.\n\t\t\t\t\tsmartcard=False,)\n\n\t\t\t# create an ssh alias for a smart card.\n\t\t\telse:\n\t\t\t\tresponse = ssht00ls.aliases.create( \n\t\t\t\t\t# the alias.\n\t\t\t\t\talias=self.arguments.get('--alias', chapter=\"aliases\", mode=\"--create-alias\"), \n\t\t\t\t\t# the username.\n\t\t\t\t\tusername=self.arguments.get('--username', chapter=\"aliases\", mode=\"--create-alias\"), \n\t\t\t\t\t# the public ip of the server.\n\t\t\t\t\tpublic_ip=self.arguments.get('--public-ip', chapter=\"aliases\", mode=\"--create-alias\"),\n\t\t\t\t\t# the public port of the server.\n\t\t\t\t\tpublic_port=self.arguments.get('--public-port', chapter=\"aliases\", mode=\"--create-alias\"),\n\t\t\t\t\t# the private ip of the server.\n\t\t\t\t\tprivate_ip=self.arguments.get('--private-ip', chapter=\"aliases\", mode=\"--create-alias\"),\n\t\t\t\t\t# the private port of the server.\n\t\t\t\t\tprivate_port=self.arguments.get('--private-port', chapter=\"aliases\", mode=\"--create-alias\"),\n\t\t\t\t\t# the path to the private key.\n\t\t\t\t\tkey=smartcard.path,\n\t\t\t\t\t# smart card.\n\t\t\t\t\tsmartcard=True,\n\t\t\t\t\tpin=self.arguments.get('--pin', required=False, default=None, chapter=\"aliases\", mode=\"--create-alias\"), )\n\n\t\t\t# log to console.\n\t\t\tself.stop(response=response, json=JSON)\n\n\t\t# check create ssh config.\n\t\telif self.arguments.present('--generate'):\n\t\t\t\n\t\t\t# generate a key.\n\t\t\tpassphrase = self.arguments.get(\"--passphrase\", required=required).replace(\"\\\\\", \"\").replace(\"\\ \", \"\")\n\t\t\tif passphrase in [\"\", None, \"null\", \"None\", \"none\"]: passphrase = None\n\t\t\tresponse = ssht00ls.keys.generate(\n\t\t\t\tpath=self.arguments.get(\"--path\", chapter=\"keys\", mode=\"--generate\"), \n\t\t\t\tpassphrase=passphrase, \n\t\t\t\tcomment=self.arguments.get(\"--comment\", chapter=\"keys\", mode=\"--generate\"),)\n\t\t\tself.stop(response=response, json=JSON)\n\n\t\t# kill ssh processes.\n\t\telif self.arguments.present('--kill'):\n\t\t\tresponse = ssht00ls.utils.kill_ssh(\n\t\t\t\tidentifier=self.arguments.get(\"--kill\"), \n\t\t\t\tsudo=self.arguments.present(\"--sudo\"),)\n\t\t\tself.stop(response=response, json=JSON)\n\n\t\t# pull.\n\t\telif self.arguments.present('--pull'):\n\t\t\tremote = self.arguments.get(\"--pull\", index=1, chapter=\"push \u0026 pull\", mode=\"--pull\")\n\t\t\tpath = self.arguments.get(\"--pull\", index=2, chapter=\"push \u0026 pull\", mode=\"--pull\")\n\t\t\tif \":\" not in remote:\n\t\t\t\tself.docs(\n\t\t\t\t\terror=f\"Invalid \u003calias\u003e:\u003cremote\u003e \u003cpath\u003e format.\", \n\t\t\t\t\tchapter=\"push \u0026 pull\", \n\t\t\t\t\tmode=\"--pull\", \n\t\t\t\t\tnotes={\n\t\t\t\t\t\t\"\u003calias\u003e:\u003cpath\u003e\":\"Pack the alias \u0026 tuple together as one argument in the following format [\u003calias\u003e:\u003cpath\u003e].\"\n\t\t\t\t\t},\n\t\t\t\t\tjson=JSON,)\n\t\t\talias,remote = remote.split(\":\")\n\t\t\texclude = None\n\t\t\tif self.arguments.present(\"--exclude\"): \n\t\t\t\texclude = self.arguments.get(\"--exclude\", chapter=\"push \u0026 pull\", mode=\"--pull\").split(\",\")\n\t\t\telif self.arguments.present(\"--no-exclude\"): exclude = []\n\t\t\tresponse = ssht00ls.ssync.pull(\n\t\t\t\talias=alias, \n\t\t\t\tremote=remote, \n\t\t\t\tpath=path,\n\t\t\t\texclude=exclude, \n\t\t\t\tforced=self.arguments.present(\"--forced\"), \n\t\t\t\tdelete=self.arguments.present(\"--delete\"), \n\t\t\t\tsafe=self.arguments.present(\"--safe\"), )\n\t\t\tself.stop(response=response, json=JSON)\n\n\t\t# push.\n\t\telif self.arguments.present('--push'):\n\t\t\tpath = self.arguments.get(\"--push\", index=1, chapter=\"push \u0026 pull\", mode=\"--push\")\n\t\t\tremote = self.arguments.get(\"--push\", index=2, chapter=\"push \u0026 pull\", mode=\"--push\")\n\t\t\tif \":\" not in remote:\n\t\t\t\tself.docs(\n\t\t\t\t\terror=f\"Invalid \u003calias\u003e:\u003cremote\u003e \u003cpath\u003e.\", \n\t\t\t\t\tchapter=\"push \u0026 pull\", \n\t\t\t\t\tmode=\"--push\", \n\t\t\t\t\tnotes={\n\t\t\t\t\t\t\"\u003calias\u003e:\u003cpath\u003e\":\"Pack the alias \u0026 tuple together as one argument in the following format [\u003calias\u003e:\u003cpath\u003e].\"\n\t\t\t\t\t},\n\t\t\t\t\tjson=JSON,)\n\t\t\talias,remote = remote.split(\":\")\n\t\t\texclude = None\n\t\t\tif self.arguments.present(\"--exclude\"): \n\t\t\t\texclude = self.arguments.get(\"--exclude\", chapter=\"push \u0026 pull\", mode=\"--push\").split(\",\")\n\t\t\telif self.arguments.present(\"--no-exclude\"): exclude = []\n\t\t\tresponse = ssht00ls.ssync.push(\n\t\t\t\talias=alias, \n\t\t\t\tremote=remote, \n\t\t\t\tpath=path,\n\t\t\t\texclude=exclude, \n\t\t\t\tforced=self.arguments.present(\"--forced\"), \n\t\t\t\tdelete=self.arguments.present(\"--delete\"), \n\t\t\t\tsafe=self.arguments.present(\"--safe\"), )\n\t\t\tself.stop(response=response, json=JSON)\n\n\t\t# mount.\n\t\telif self.arguments.present('--mount'):\n\t\t\tremote = self.arguments.get(\"--mount\", index=1, chapter=\"mounts\", mode=\"--mount\", notes={})\n\t\t\tpath = self.arguments.get(\"--mount\", index=2, chapter=\"mounts\", mode=\"--mount\", notes={})\n\t\t\tif \":\" not in remote:\n\t\t\t\tself.docs(\n\t\t\t\t\terror=f\"Invalid \u003calias\u003e:\u003cremote\u003e \u003cpath\u003e.\", \n\t\t\t\t\tchapter=\"mounts\", \n\t\t\t\t\tmode=\"--mount\", \n\t\t\t\t\tnotes={\n\t\t\t\t\t\t\"\u003calias\u003e:\u003cpath\u003e\":\"Pack the alias \u0026 tuple together as one argument in the following format [\u003calias\u003e:\u003cpath\u003e].\"\n\t\t\t\t\t},\n\t\t\t\t\tjson=JSON,)\n\t\t\talias,remote = remote.split(\":\")\n\t\t\tresponse = ssht00ls.ssync.mount(\n\t\t\t\talias=alias, \n\t\t\t\tremote=remote, \n\t\t\t\tpath=path,\n\t\t\t\tforced=self.arguments.present(\"--forced\"), )\n\t\t\tself.stop(response=response, json=JSON)\n\n\t\t# unmount.\n\t\telif self.arguments.present('--unmount'):\n\t\t\tpath = self.arguments.get(\"--unmount\", index=1, chapter=\"mounts\", mode=\"--unmount\")\n\t\t\tresponse = ssht00ls.ssync.unmount(\n\t\t\t\tpath=path,\n\t\t\t\tforced=self.arguments.present(\"--forced\"), \n\t\t\t\tsudo=self.arguments.present(\"--sudo\"), )\n\t\t\tself.stop(response=response, json=JSON)\n\n\t\t# index.\n\t\telif self.arguments.present('--index'):\n\t\t\tindex = self.arguments.get(\"--index\", chapter=\"mounts\", mode=\"--index\")\n\t\t\tif \":\" in index:\n\t\t\t\talias,remote = index.split(\":\")\n\t\t\t\tresponse = ssht00ls.ssync.index(path=remote, alias=alias)\n\t\t\telse:\n\t\t\t\tresponse = ssht00ls.ssync.index(path=index)\n\t\t\tself.stop(response=response, json=JSON)\n\n\t\t# start daemon.\n\t\telif self.arguments.present('--start-daemon'):\n\t\t\tremote = self.arguments.get(\"--start-daemon\", index=1, chapter=\"daemons\", mode=\"--start-daemon\")\n\t\t\tpath = self.arguments.get(\"--start-daemon\", index=2, chapter=\"daemons\", mode=\"--start-daemon\")\n\t\t\tif \":\" not in remote:\n\t\t\t\tself.docs(\n\t\t\t\t\terror=f\"Invalid \u003calias\u003e:\u003cremote\u003e \u003cpath\u003e.\", \n\t\t\t\t\tchapter=\"damons\", \n\t\t\t\t\tmode=\"--start-daemon\", \n\t\t\t\t\tnotes={\n\t\t\t\t\t\t\"\u003calias\u003e:\u003cpath\u003e\":\"Pack the alias \u0026 tuple together as one argument in the following format [\u003calias\u003e:\u003cpath\u003e].\"\n\t\t\t\t\t},\n\t\t\t\t\tjson=JSON,)\n\t\t\talias,remote = remote.split(\":\")\n\t\t\tresponse = ssht00ls.ssync.daemon(alias=alias, remote=remote, path=path)\n\t\t\tself.stop(response=response, json=JSON)\n\n\t\t# stop daemon.\n\t\telif self.arguments.present('--stop-daemon'):\n\t\t\tpath = self.arguments.get(\"--stop-daemon\", index=1, chapter=\"daemon\", mode=\"--stop-daemon\")\n\t\t\tresponse = ssht00ls.ssync.stop_daemon(path)\n\t\t\tself.stop(response=response, json=JSON)\n\n\t\t# config.\n\t\telif self.arguments.present('--config'):\n\t\t\tif JSON:\n\t\t\t\tprint(CONFIG.dictionary)\n\t\t\telse:\n\t\t\t\tos.system(f\"nano {CONFIG.file_path.path}\")\n\n\t\t# invalid.\n\t\telse: self.invalid()\n\n\t\t#\n\t\n# main.\nif __name__ == \"__main__\":\n\tcli = CLI()\n\tcli.start()\n\n```\n\n# Code Examples:\n\n### Table of content:\n- [__CLI__](#cli)\n  - [__CLI__](#cli)\n    * [stop](#stop)\n    * [docs](#docs)\n    * [invalid](#invalid)\n- [__Classes__](#classes)\n  - [__Formats__](#formats)\n  - [__Files__](#files)\n    * [join](#join)\n    * [load](#load)\n    * [save](#save)\n    * [delete](#delete)\n    * [chmod](#chmod)\n    * [chown](#chown)\n    * [exists](#exists)\n    * [directory](#directory)\n    * [mounted](#mounted)\n    * [create](#create)\n    * [copy](#copy)\n    * [move](#move)\n- [__Code__](#code)\n  - [__Spawn__](#spawn)\n    * [start](#start)\n    * [expect](#expect)\n    * [read](#read)\n    * [kill](#kill)\n    * [wait](#wait)\n    * [crashed](#crashed)\n    * [expecting](#properties)\n  - [__OutputObject__](#outputobject)\n    * [instance](#instance)\n    * [response](#response)\n- [__Console__](#console)\n  - [__Loader__](#loader)\n    * [run](#run)\n    * [stop](#stop-1)\n    * [mark](#mark)\n    * [hold](#hold)\n    * [release](#release)\n  - [__ProgressLoader__](#progressloader)\n    * [next](#next)\n    * [stop](#stop-2)\n- [__Database__](#database)\n  - [__Database__](#database)\n    * [load](#load-1)\n    * [save](#save-1)\n    * [delete](#delete-1)\n    * [paths](#paths)\n    * [names](#names)\n  - [__WebServer__](#webserver)\n    * [set](#set)\n    * [get](#get)\n    * [app](#app)\n    * [run](#run-1)\n    * [fork](#fork)\n    * [stop](#stop-3)\n    * [start_thread](#start_thread)\n    * [get_thread](#get_thread)\n    * [token](#properties-1)\n- [__Defaults__](#defaults)\n  - [__FilePath__](#filepath)\n    * [join](#join-1)\n    * [name](#name)\n    * [extension](#extension)\n    * [base](#base)\n    * [basename](#basename)\n    * [size](#size)\n    * [space](#space)\n    * [convert_bytes](#convert_bytes)\n    * [exists](#exists-1)\n    * [mount](#mount)\n    * [directory](#directory-1)\n    * [mtime](#mtime)\n    * [clean](#clean)\n    * [absolute](#absolute)\n    * [module](#module)\n    * [requirements](#requirements)\n    * [delete](#delete-2)\n    * [move](#move-1)\n    * [copy](#copy-1)\n    * [open](#open)\n    * [create](#create-1)\n    * [check](#check)\n    * [split](#split)\n    * [count](#count)\n    * [replace](#replace)\n    * [lower](#lower)\n    * [upper](#upper)\n    * [instance](#instance-1)\n    * [assign](#assign)\n    * [raw](#raw)\n  - [__Ownership__](#ownership)\n    * [get](#get-1)\n    * [set](#set-1)\n    * [check](#check-1)\n  - [__Permission__](#permission)\n    * [get](#get-2)\n    * [set](#set-2)\n    * [check](#check-2)\n  - [__String__](#string)\n    * [save](#save-2)\n    * [load](#load-2)\n    * [is_numerical](#is_numerical)\n    * [bash](#bash)\n    * [identifier](#identifier)\n    * [variable_format](#variable_format)\n    * [class_format](#class_format)\n    * [capitalized_scentence](#capitalized_scentence)\n    * [capitalized_word](#capitalized_word)\n    * [generate](#generate)\n    * [first_occurence](#first_occurence)\n    * [before_after_first_occurence](#before_after_first_occurence)\n    * [before_selected_after_first_occurence](#before_selected_after_first_occurence)\n    * [before_after_last_occurence](#before_after_last_occurence)\n    * [before_selected_after_last_occurence](#before_selected_after_last_occurence)\n    * [between](#between)\n    * [replace_between](#replace_between)\n    * [increase_version](#increase_version)\n    * [slice_dict](#slice_dict)\n    * [slice_array](#slice_array)\n    * [slice_tuple](#slice_tuple)\n    * [indent](#indent)\n    * [line_indent](#line_indent)\n    * [slice_indent](#slice_indent)\n    * [first](#first)\n    * [last](#last)\n    * [remove_first](#remove_first)\n    * [remove_last](#remove_last)\n    * [split](#split-1)\n    * [count](#count-1)\n    * [replace](#replace-1)\n    * [lower](#lower-1)\n    * [upper](#upper-1)\n    * [instance](#instance-2)\n    * [assign](#assign-1)\n    * [raw](#raw-1)\n  - [__Boolean__](#boolean)\n    * [save](#save-3)\n    * [load](#load-3)\n    * [string](#string)\n    * [instance](#instance-3)\n    * [assign](#assign-2)\n    * [raw](#raw-2)\n  - [__Integer__](#integer)\n    * [save](#save-4)\n    * [load](#load-4)\n    * [increase_version](#increase_version-1)\n    * [round](#round)\n    * [round_down](#round_down)\n    * [generate](#generate-1)\n    * [instance](#instance-4)\n    * [assign](#assign-3)\n    * [raw](#raw-3)\n  - [__Date__](#date)\n    * [initialize](#initialize)\n    * [compare](#compare)\n    * [increase](#increase)\n    * [decrease](#decrease)\n    * [to_seconds](#to_seconds)\n    * [from_seconds](#from_seconds)\n    * [convert](#convert)\n    * [parse_format](#parse_format)\n    * [assign](#assign-4)\n    * [instance](#instance-5)\n  - [__Generate__](#generate)\n    * [int](#int)\n    * [string](#string-1)\n  - [__Interval__](#interval)\n    * [sleep](#sleep)\n  - [__File__](#file)\n    * [load](#load-5)\n    * [load_line](#load_line)\n    * [save](#save-5)\n    * [check](#check-3)\n    * [instance](#instance-6)\n    * [assign](#assign-5)\n    * [raw](#raw-4)\n  - [__Array__](#array)\n    * [save](#save-6)\n    * [load](#load-6)\n    * [string](#string-2)\n    * [divide](#divide)\n    * [remove](#remove)\n    * [append](#append)\n    * [pop](#pop)\n    * [count](#count-2)\n    * [check](#check-4)\n    * [clean](#clean-1)\n    * [iterate](#iterate)\n    * [items](#items)\n    * [keys](#keys)\n    * [reversed](#reversed)\n    * [sort](#sort)\n    * [json](#json)\n    * [serialize](#serialize)\n    * [instance](#instance-7)\n    * [assign](#assign-6)\n    * [raw](#raw-5)\n  - [__Dictionary__](#dictionary)\n    * [save](#save-7)\n    * [load](#load-7)\n    * [load_line](#load_line-1)\n    * [check](#check-5)\n    * [divide](#divide-1)\n    * [append](#append-1)\n    * [edit](#edit)\n    * [unpack](#unpack)\n    * [remove](#remove-1)\n    * [count](#count-3)\n    * [insert](#insert)\n    * [iterate](#iterate-1)\n    * [items](#items-1)\n    * [keys](#keys-1)\n    * [values](#values)\n    * [reversed](#reversed-1)\n    * [sort](#sort-1)\n    * [json](#json-1)\n    * [serialize](#serialize-1)\n    * [instance](#instance-8)\n    * [assign](#assign-7)\n    * [raw](#raw-6)\n  - [__Directory__](#directory)\n    * [create](#create-2)\n    * [delete](#delete-3)\n    * [check](#check-6)\n    * [load](#load-8)\n    * [save](#save-8)\n    * [paths](#paths-1)\n    * [names](#names-1)\n    * [oldest](#oldest)\n    * [newest](#newest)\n    * [random](#random)\n    * [generate](#generate-2)\n    * [structured_join](#structured_join)\n    * [contains](#contains)\n    * [subpath](#subpath)\n    * [fullpath](#fullpath)\n    * [set_icon](#set_icon)\n    * [index](#index)\n    * [open](#open-1)\n    * [find](#find)\n    * [replace](#replace-2)\n    * [join](#join-2)\n    * [name](#name-1)\n    * [base](#base-1)\n    * [basename](#basename-1)\n    * [instance](#instance-9)\n    * [raw](#raw-7)\n  - [__Image__](#image)\n    * [load](#load-9)\n    * [edit_pixel](#edit_pixel)\n    * [convert](#convert-1)\n    * [replace_pixels](#replace_pixels)\n    * [replace_colors](#replace_colors)\n    * [rgb_to_hex](#rgb_to_hex)\n    * [hex_to_rgb](#hex_to_rgb)\n    * [instance](#instance-10)\n    * [raw](#raw-8)\n  - [__Zip__](#zip)\n    * [create](#create-3)\n    * [extract](#extract)\n    * [instance](#instance-11)\n    * [raw](#raw-9)\n  - [__Bytes__](#bytes)\n    * [load](#load-10)\n    * [save](#save-9)\n    * [instance](#instance-12)\n    * [assign](#assign-8)\n    * [raw](#raw-10)\n  - [__Color__](#color)\n    * [remove](#remove-2)\n    * [fill](#fill)\n    * [boolean](#boolean)\n  - [__Symbol__](#symbol)\n  - [__Defaults__](#defaults)\n    * [operating_system](#operating_system)\n    * [alias](#alias)\n    * [source_path](#source_path)\n    * [log_level](#log_level)\n    * [pwd](#pwd)\n    * [insert](#insert-1)\n    * [site_packages](#site_packages)\n    * [install_requirements](#install_requirements)\n    * [interactive](#interactive)\n  - [__Traceback__](#traceback)\n    * [traceback](#properties-2)\n  - [__Object__](#object)\n    * [items](#items-2)\n    * [keys](#keys-2)\n    * [values](#values-1)\n    * [assign](#assign-9)\n    * [attributes](#attributes)\n    * [dict](#dict)\n    * [unpack](#unpack-1)\n  - [__Thread__](#thread)\n    * [run](#run-2)\n    * [safe_start](#safe_start)\n    * [safe_stop](#safe_stop)\n    * [send_stop](#send_stop)\n    * [send_crash](#send_crash)\n    * [log](#log)\n    * [run_permission](#properties-3)\n- [__Encryption__](#encryption)\n  - [__AES__](#aes)\n    * [encrypt](#encrypt)\n    * [decrypt](#decrypt)\n    * [get_key](#get_key)\n    * [generate_salt](#generate_salt)\n  - [__AsymmetricAES__](#asymmetricaes)\n    * [generate_keys](#generate_keys)\n    * [load_keys](#load_keys)\n    * [load_private_key](#load_private_key)\n    * [load_public_key](#load_public_key)\n    * [edit_passphrase](#edit_passphrase)\n    * [encrypt](#encrypt-1)\n    * [decrypt](#decrypt-1)\n    * [encrypt_file](#encrypt_file)\n    * [decrypt_file](#decrypt_file)\n    * [encrypt_directory](#encrypt_directory)\n    * [decrypt_directory](#decrypt_directory)\n    * [generated](#properties-4)\n  - [__Database-1__](#database)\n    * [activate](#activate)\n    * [check](#check-7)\n    * [load](#load-11)\n    * [save](#save-10)\n    * [activated](#properties-5)\n  - [__File-1__](#file)\n    * [load](#load-12)\n    * [save](#save-11)\n  - [__Array-1__](#array)\n    * [load](#load-13)\n    * [save](#save-12)\n  - [__Dictionary-1__](#dictionary)\n    * [load](#load-14)\n    * [save](#save-13)\n  - [__RSA__](#rsa)\n    * [generate_keys](#generate_keys-1)\n    * [load_keys](#load_keys-1)\n    * [load_public_key](#load_public_key-1)\n    * [load_private_key](#load_private_key-1)\n    * [edit_passphrase](#edit_passphrase-1)\n    * [encrypt_string](#encrypt_string)\n    * [encrypt_file](#encrypt_file-1)\n    * [encrypt_directory](#encrypt_directory-1)\n    * [decrypt_string](#decrypt_string)\n    * [decrypt_file](#decrypt_file-1)\n    * [decrypt_directory](#decrypt_directory-1)\n    * [generated](#properties-6)\n  - [__Agent__](#agent)\n    * [generate](#generate-3)\n    * [activate](#activate-1)\n    * [encrypt](#encrypt-2)\n    * [decrypt](#decrypt-2)\n    * [activated](#properties-7)\n- [__Network__](#network)\n  - [__FireWall__](#firewall)\n    * [enable](#enable)\n    * [disable](#disable)\n    * [allow](#allow)\n    * [deny](#deny)\n    * [allow_all](#allow_all)\n    * [deny_all](#deny_all)\n    * [set_default](#set_default)\n    * [info](#info)\n  - [__Network__](#network)\n    * [info](#info-1)\n    * [convert_dns](#convert_dns)\n    * [ping](#ping)\n    * [port_in_use](#port_in_use)\n    * [free_port](#free_port)\n- [__Requests__](#requests)\n  - [__Requests__](#requests)\n    * [encode](#encode)\n    * [quote](#quote)\n    * [unquote](#unquote)\n    * [serialize](#serialize-2)\n    * [get](#get-3)\n  - [__RestAPI__](#restapi)\n    * [get](#get-4)\n- [__Response__](#response)\n  - [__Response__](#response)\n    * [success](#success)\n    * [error](#error)\n    * [log](#log-2)\n    * [load_logs](#load_logs)\n    * [reset_logs](#reset_logs)\n    * [serialize](#serialize-3)\n    * [response](#response-2)\n    * [log_to_file](#log_to_file)\n    * [quote](#quote-1)\n    * [unquote](#unquote-1)\n  - [__Parameters__](#parameters)\n    * [get](#get-5)\n    * [check](#check-8)\n  - [__ResponseObject__](#responseobject)\n    * [clean](#clean-2)\n    * [assign](#assign-10)\n    * [crash](#crash)\n    * [unpack](#unpack-3)\n    * [remove](#remove-3)\n    * [iterate](#iterate-2)\n    * [items](#items-3)\n    * [keys](#keys-3)\n    * [values](#values-2)\n    * [reversed](#reversed-2)\n    * [sort](#sort-2)\n    * [dict](#dict-1)\n    * [json](#json-2)\n    * [serialize](#serialize-4)\n    * [instance](#instance-13)\n    * [raw](#raw-11)\n    * [response](#response-3)\n- [__System__](#system)\n  - [__Service__](#service)\n    * [create](#create-4)\n    * [check](#check-9)\n    * [delete](#delete-4)\n    * [start](#start-1)\n    * [stop](#stop-4)\n    * [restart](#restart)\n    * [status](#status)\n    * [reset_logs](#reset_logs-1)\n    * [tail](#tail)\n  - [__User__](#user)\n    * [create](#create-5)\n    * [delete](#delete-5)\n    * [check](#check-10)\n    * [set_password](#set_password)\n    * [add_groups](#add_groups)\n    * [delete_groups](#delete_groups)\n  - [__Group__](#group)\n    * [create](#create-6)\n    * [delete](#delete-6)\n    * [check](#check-11)\n    * [list_users](#list_users)\n    * [delete_users](#delete_users)\n    * [add_users](#add_users)\n    * [check_users](#check_users)\n  - [__Env__](#env)\n    * [fill](#fill-1)\n    * [import_](#import_)\n    * [export](#export)\n    * [get](#get-6)\n    * [get_string](#get_string)\n    * [get_boolean](#get_boolean)\n    * [get_integer](#get_integer)\n    * [get_array](#get_array)\n    * [get_tuple](#get_tuple)\n    * [get_dictionary](#get_dictionary)\n    * [set](#set-3)\n    * [set_string](#set_string)\n    * [set_boolean](#set_boolean)\n    * [set_integer](#set_integer)\n    * [set_array](#set_array)\n    * [set_tuple](#set_tuple)\n    * [set_dictionary](#set_dictionary)\n  - [__Browser__](#browser)\n    * [get](#get-7)\n    * [get_element](#get_element)\n  - [__Disks__](#disks)\n    * [list](#list)\n    * [erase](#erase)\n    * [partition](#partition)\n    * [format](#format)\n    * [mount](#mount-1)\n    * [unmount](#unmount)\n\n## CLI:\nThe cli object class.\n``` python \n\n# initialize the dev0s.cli.CLI object class.\ncli = dev0s.cli.CLI(\n    # the alias (str).\n    alias=None,\n    # the modes (dict).\n    modes={},\n    # the options (dict).\n    options={},\n    # the documentation notes (dict).\n    notes={},\n    # the path to the executable (str, FilePath).\n    executable=__file__,\n    # the author's name (str).\n    author=\"Daan van den Bergh\", )\n\n```\n\n#### Functions:\n\n##### stop:\n``` python\n\n# call cli.stop.\n_ = cli.stop(\n    # success exit (bool).\n    success=True,\n    # optional order 1 success message (overwrites success to response.success) (ResponseObject, OutputObject, dict).\n    response={},\n    # optional order 2 success message (overwrites success to True) (str).\n    message=None,\n    # optional order 3 message (str).\n    error=None,\n    # json format (bool).\n    json=False, )\n\n```\n##### docs:\n``` python\n\n# call cli.docs.\n_ = cli.docs(\n    # the chapter (optional) (str).\n    chapter=None,\n    # the mode (optional) (str).\n    mode=None,\n    # success exit.\n    success=True,\n    # optional order 1 success message (overwrites success to response.success) (ResponseObject, OutputObject).\n    response={},\n    # optional order 2 success message (overwrites success to True) (str).\n    message=None,\n    # optional order 3 message (str).\n    error=None,\n    # dump response as json format (bool).\n    json=False,\n    # stop after show  (bool).\n    stop=True,\n    # overwrite default notes (optional)  (dict).\n    notes=None, )\n\n```\n##### invalid:\n``` python\n\n# call cli.invalid.\n_ = cli.invalid(\n    # the selected error (str).\n    error=\"Selected an invalid mode.\",\n    # the selected chapter (str).\n    chapter=None,\n    # the active mode (str).\n    mode=None,\n    # dump response as json format (bool).\n    json=False, )\n\n```\n\n## Formats:\nThe formats object class.\n``` python \n\n# initialize the dev0s.classes.defaults.files.Formats object class.\nformats = dev0s.classes.defaults.files.Formats\n\n```\n## Files:\nThe files object class.\n``` python \n\n# initialize the dev0s.classes.defaults.files.Files object class.\nfiles = dev0s.classes.defaults.files.Files(path=None, name=None, type=\"\")\n\n```\n\n#### Functions:\n\n##### join:\n``` python\n\n# call files.join.\n_ = Files.join(path=None, name=None, type=\"\")\n\n```\n##### load:\n``` python\n\n# call files.load.\n_ = Files.load(path, data=\"not to be used\", format=\"str\", raw=False, sudo=False)\n\n```\n##### save:\n``` python\n\n# call files.save.\n_ = Files.save(\n    # the path (str) (#1).\n    path,\n    # the data (str, dict, list) (#2).\n    data,\n    # the file format, options: [str, bytes, json].\n    format=\"str\",\n    # root permission required.\n    sudo=False,\n    # json options.\n    indent=4,\n    ensure_ascii=False,\n    # create backups.\n    backups=False,\n    # warning: safe True keeps infinitely trying to save the doc when an KeyboardInterrupt is raised by the user.\n    safe=True,\n    # system functions.\n    __loader__=None,\n    __checks__=True,\n    __keyboard_interrupt__=False,\n    __attempt__=1,\n    __real_path__=None, )\n\n```\n##### delete:\n``` python\n\n# call files.delete.\n_ = Files.delete(\n    # the path (param #1).\n    path=None,\n    # root permission required.\n    sudo=False,\n    # forced mode.\n    forced=False,\n    # hide logs.\n    silent=False, )\n\n```\n##### chmod:\n``` python\n\n# call files.chmod.\n_ = Files.chmod(\n    # the path (param #1).\n    path=None,\n    # the new permission.\n    permission=None,\n    # recursive for entire dir.\n    recursive=False,\n    # root permission required.\n    sudo=False, )\n\n```\n##### chown:\n``` python\n\n# call files.chown.\n_ = Files.chown(\n    # the path (param #1).\n    path=None,\n    # the new owner.\n    owner=None,\n    # the new group (optional).\n    group=None,\n    # recursive for entire dir.\n    recursive=False,\n    # root permission required.\n    sudo=False, )\n\n```\n##### exists:\n``` python\n\n# call files.exists.\n_ = Files.exists(path=None, sudo=False)\n\n```\n##### directory:\n``` python\n\n# call files.directory.\n_ = Files.directory(\n    # the path (#1).\n    path=None,\n    # root permission required.\n    sudo=False, )\n\n```\n##### mounted:\n``` python\n\n# call files.mounted.\n_ = Files.mounted(\n    # the path (#1).\n    path=None, )\n\n```\n##### create:\n``` python\n\n# call files.create.\n_ = Files.create(\n    # the path to the file (str) (required) (#1).\n    path=None,\n    # the data (str) (optional).\n    data=None,\n    # path is directory (bool).\n    directory=False,\n    # the owner (str) (optional).\n    owner=None,\n    # the group (str) (optional).\n    group=None,\n    # the permission (int) (optional).\n    permission=None,\n    # root permission required.\n    sudo=False, )\n\n```\n##### copy:\n``` python\n\n# call files.copy.\n_ = Files.copy(\n    # the from \u0026 to path (#1 \u0026 #2).\n    from_, to_,\n    # root permission required.\n    sudo=False,\n    # root permission required.\n    log_level=0, )\n\n```\n##### move:\n``` python\n\n# call files.move.\n_ = Files.move(\n    # the from \u0026 to path (#1 \u0026 #2).\n    from_, to_,\n    # root permission required.\n    sudo=False,\n    # root permission required.\n    log_level=0, )\n\n```\n\n## Spawn:\nThe spawn object class.\n``` python \n\n# initialize the dev0s.code.Spawn object class.\nspawn = dev0s.code.Spawn(\n    #\n    # Should be initialized with function: dev0s.code.execute\n    #\n    # the full command (str) (#1).\n    command=\"ls\",\n    # asynchronous.\n    async_=False,\n    # the log level.\n    log_level=defaults.options.log_level,\n    # additional attributes.\n    attributes={},\n    # system options.\n    response_str=None, )\n\n```\n\n#### Functions:\n\n##### start:\n``` python\n\n# call spawn.start.\nresponse = spawn.start()\n\n```\n##### expect:\n``` python\n\n# call spawn.expect.\nresponse = spawn.expect(\n    # the expected data parameter (#1).\n    #    str instantce: expect a single identifier.\n    #    list instance: expect one of the provided identifiers \u0026 return the found one if success.\n    expect=[\"Password*\"],\n    # the optional data to send (#2).\n    #    none instance: do not send anything.\n    #    str instance: the data to send.\n    #    list/tuple instance: send value of index from expected expect (required expect to be a list, Array \u0026 the indexes of [expect, send] be match).\n    send=None,\n    # the timeout (float).\n    timeout=1.0, )\n\n```\n##### read:\n``` python\n\n# call spawn.read.\nresponse = spawn.read(\n    # with await False it reads only the printed output regardless the status \u0026 never throws timeout.\n    wait=False,\n    # the timeout, leave None for no timeout.\n    timeout=None,\n    # the live boolean (bool) (prints live logs to console when enabled) (leave None to use spawn.log_level \u003e= 1).\n    live=None,\n    # system variables.\n    #   safe True always a response.output variable upon error the response.output is \"\".\n    __safe__=False, )\n\n```\n##### kill:\n``` python\n\n# call spawn.kill.\nresponse = spawn.kill()\n\n```\n##### wait:\n``` python\n\n# call spawn.wait.\nresponse = spawn.wait(\n    # the live boolean (bool) (prints live logs to console when enabled) (leave None to use spawn.log_level \u003e= 1).\n    live=None,\n    sleeptime=1,\n    # the timeout (leave None to ignore).\n    timeout=None, )\n\n```\n##### crashed:\n``` python\n\n# call spawn.crashed.\nresponse = spawn.crashed()\n\n```\n\n#### Properties:\n```python\n\n# the expecting property.\nexpecting = spawn.expecting\n```\n```python\n\n# the running property.\nrunning = spawn.running\n```\n```python\n\n# the exit status property.\nexit_status = spawn.exit_status\n```\n```python\n\n# the output property.\noutput = spawn.output\n```\n```python\n\n# the pid property.\npid = spawn.pid\n```\n\n## OutputObject:\nThe output_object object class.\n``` python \n\n# initialize the dev0s.code.OutputObject object class.\noutput_object = dev0s.code.OutputObject(\n    #\n    # The return object from function: dec0s.code.execute\n    # The OutputObject object is very similair to the ResponseObject.\n    #\n    # the success message (param #1).\n    message=None,\n    # the attributes (param #2).\n    attributes={},\n    # the error message (param #3).\n    error=None,\n    # the log level.\n    log_level=defaults.options.log_level, )\n\n```\n\n#### Functions:\n\n##### instance:\n``` python\n\n# call output_object.instance.\n_ = output_object.instance()\n\n```\n##### response:\n``` python\n\n# call output_object.response.\nresponse = output_object.response()\n\n```\n\n## Loader:\nThe loader object class.\n``` python \n\n# initialize the Loader object class.\nloader = Loader(message, autostart=True, log_level=0, interactive=True)\n\n```\n\n#### Functions:\n\n##### run:\n``` python\n\n# call loader.run.\n_ = loader.run()\n\n```\n##### stop:\n``` python\n\n# call loader.stop.\n_ = loader.stop(message=None, success=True, response=None, quiet=False)\n\n```\n##### mark:\n``` python\n\n# call loader.mark.\n_ = loader.mark(new_message=None, old_message=None, success=True, response=None)\n\n```\n##### hold:\n``` python\n\n# call loader.hold.\n_ = loader.hold()\n\n```\n##### release:\n``` python\n\n# call loader.release.\n_ = loader.release()\n\n```\n\n## ProgressLoader:\nThe progress_loader object class.\n``` python \n\n# initialize the ProgressLoader object class.\nprogress_loader = ProgressLoader(message, index=0, max=10, log_level=0)\n\n```\n\n#### Functions:\n\n##### next:\n``` python\n\n# call progress_loader.next.\n_ = progress_loader.next(count=1, decimals=2)\n\n```\n##### stop:\n``` python\n\n# call progress_loader.stop.\n_ = progress_loader.stop(message=None, success=True, response=None)\n\n```\n\n## Database:\nThe database object class.\n``` python \n\n# initialize the dev0s.database.Database object class.\ndatabase = dev0s.database.Database(\n    # the path to the directory (str) (#1)\n    path=None,\n    # root permission required.\n    sudo=False, )\n\n```\n\n#### Functions:\n\n##### load:\n``` python\n\n# call database.load.\nresponse = database.load(\n    # the sub path (str, FilePath) (#1).\n    path=None,\n    # the data format [bool, str, int, float, dict, list] (str) (#2).\n    format=\"dict\",\n    # the default data (bool, str, int, float, dict, list).\n    default=None, )\n\n```\n##### save:\n``` python\n\n# call database.save.\nresponse = database.save(\n    # the sub path (str, FilePath) (#1).\n    path=None,\n    # the data to save (bool, str, int, float, dict, list) (#2)\n    data=None,\n    # the data format [bool, str, int, float, dict, list] (str) (#3).\n    format=\"dict\",\n    # with overwrite disabled the dict format data is inserted into the existing data (bool).\n    overwrite=False, )\n\n```\n##### delete:\n``` python\n\n# call database.delete.\nresponse = database.delete(\n    # the sub path (str, FilePath) (#1).\n    path=None, )\n\n```\n##### paths:\n``` python\n\n# call database.paths.\nresponse = database.paths(\n    # the sub path (leave None to use the root path) (str FilePath)\n    path=None,\n    # get recursively (bool).\n    recursive=False,\n    # get files only (bool).\n    files_only=False,\n    # get firs only (bool).\n    dirs_only=False,\n    # also get empty dirs (bool).\n    empty_dirs=True,\n    # get the full path (bool).\n    full_path=False,\n    # the banned full paths (list).\n    banned=[],\n    # the banned names (list).\n    banned_names=[\".DS_Store\"],\n    # the banend base names (list).\n    banned_basenames=[\"__pycache__\"],\n    # the allowed extensions (list).\n    extensions=[\"*\"], )\n\n```\n##### names:\n``` python\n\n# call database.names.\nresponse = database.names(\n    # the sub path (leave None to use the root path)\n    path=None,\n    # get recursively (bool).\n    recursive=False,\n    # get files only (bool).\n    files_only=False,\n    # get firs only (bool).\n    dirs_only=False,\n    # also get empty dirs (bool).\n    empty_dirs=True,\n    # remove the extension names (bool).\n    remove_extensions=True,\n    # the banned full paths (list).\n    banned=[],\n    # the banned names (list).\n    banned_names=[\".DS_Store\"],\n    # the banend base names (list).\n    banned_basenames=[\"__pycache__\"],\n    # the allowed extensions (list).\n    extensions=[\"*\"], )\n\n```\n\n## WebServer:\nThe webserver object class.\n``` python \n\n# initialize the dev0s.database.WebServer object class.\nwebserver = dev0s.database.WebServer(\n    id=\"webserver\",\n    host=\"127.0.0.1\",\n    port=52379,\n    sleeptime=3,\n    log_level=0,\n    # do not use.\n    serialized={}, )\n\n```\n\n#### Functions:\n\n##### set:\n``` python\n\n# call webserver.set.\nresponse = webserver.set(group=None, id=None, data=None, timeout=3)\n\n```\n##### get:\n``` python\n\n# call webserver.get.\nresponse = webserver.get(group=None, id=None, timeout=3)\n\n```\n##### app:\n``` python\n\n# call webserver.app.\nresponse = webserver.app()\n\n```\n##### run:\n``` python\n\n# call webserver.run.\n_ = webserver.run()\n\n```\n##### fork:\n``` python\n\n# call webserver.fork.\nresponse = webserver.fork(timeout=15, sleeptime=1)\n\n```\n##### stop:\n``` python\n\n# call webserver.stop.\nresponse = webserver.stop()\n\n```\n##### start_thread:\n``` python\n\n# call webserver.start_thread.\nresponse = webserver.start_thread(thread, group=\"daemons\", id=None)\n\n```\n##### get_thread:\n``` python\n\n# call webserver.get_thread.\nresponse = webserver.get_thread(group=\"daemos\", id=None)\n\n```\n\n#### Properties:\n```python\n\n# the token property.\ntoken = webserver.token\n```\n```python\n\n# the running property.\nrunning = webserver.running\n```\n\n## FilePath:\nThe file_path object class.\n``` python \n\n# initialize the FilePath object class.\nfile_path = FilePath(path, default=False, check=False, load=False)\n\n```\n\n#### Functions:\n\n##### join:\n``` python\n\n# call file_path.join.\n_ = file_path.join(name=None, type=\"/\")\n\n```\n##### name:\n``` python\n\n# call file_path.name.\n_ = file_path.name(path=None, remove_extension=False,)\n\n```\n##### extension:\n``` python\n\n# call file_path.extension.\n_ = file_path.extension(name=None, path=None)\n\n```\n##### base:\n``` python\n\n# call file_path.base.\n_ = file_path.base(\n    # the path (leave None to use file_path.path) (param #1).\n    path=None,\n    # the dirs back.\n    back=1, )\n\n```\n##### basename:\n``` python\n\n# call file_path.basename.\n_ = file_path.basename(back=1, path=None)\n\n```\n##### size:\n``` python\n\n# call file_path.size.\n_ = file_path.size(format=str,  mode=\"auto\", path=None, options=[\"auto\", \"bytes\", \"kb\", \"mb\", \"gb\", \"tb\"])\n\n```\n##### space:\n``` python\n\n# call file_path.space.\n_ = file_path.space(format=str,  mode=\"auto\", path=None, options=[\"auto\", \"bytes\", \"kb\", \"mb\", \"gb\", \"tb\"])\n\n```\n##### convert_bytes:\n``` python\n\n# call file_path.convert_bytes.\n_ = file_path.convert_bytes(bytes:int, format=str, mode=\"auto\", options=[\"auto\", \"bytes\", \"kb\", \"mb\", \"gb\", \"tb\"])\n\n```\n##### exists:\n``` python\n\n# call file_path.exists.\n_ = file_path.exists(\n    # the path (leave None to use file_path.path) (#1).\n    path=None,\n    # root permission required.\n    sudo=False, )\n\n```\n##### mount:\n``` python\n\n# call file_path.mount.\n_ = file_path.mount(\n    # the path (leave None to use file_path.path) (#1).\n    path=None, )\n\n```\n##### directory:\n``` python\n\n# call file_path.directory.\n_ = file_path.directory(\n    # the path (leave None to use file_path.path) (#1).\n    path=None, )\n\n```\n##### mtime:\n``` python\n\n# call file_path.mtime.\n_ = file_path.mtime(format='%d-%m-%y %H:%M.%S', path=None)\n\n```\n##### clean:\n``` python\n\n# call file_path.clean.\n_ = file_path.clean(\n    # the path (leave None to use file_path.path) (param #1).\n    path=None,\n    # the clean options.\n    remove_double_slash=True,\n    remove_first_slash=False,\n    remove_last_slash=False,\n    ensure_first_slash=False,\n    ensure_last_slash=False, )\n\n```\n##### absolute:\n``` python\n\n# call file_path.absolute.\n_ = file_path.absolute(\n    # the path (leave None to use file_path.path) (param #1).\n    path=None, )\n\n```\n##### module:\n``` python\n\n# call file_path.module.\n_ = file_path.module(path=None)\n\n```\n##### requirements:\n``` python\n\n# call file_path.requirements.\n_ = file_path.requirements(path=None, format=\"pip\", include_version=True)\n\n```\n##### delete:\n``` python\n\n# call file_path.delete.\n_ = file_path.delete(\n    # the path (leave None to use file_path.path) (param #1).\n    path=None,\n    # the options.\n    forced=False,\n    sudo=False,\n    silent=False, )\n\n```\n##### move:\n``` python\n\n# call file_path.move.\n_ = file_path.move(path=None, sudo=False, silent=False)\n\n```\n##### copy:\n``` python\n\n# call file_path.copy.\n_ = file_path.copy(path=None, sudo=False, silent=False)\n\n```\n##### open:\n``` python\n\n# call file_path.open.\n_ = file_path.open(sudo=False)\n\n```\n##### create:\n``` python\n\n# call file_path.create.\n_ = file_path.create(\n    #   Option 1: (creating a directory)\n    #   -   boolean format:\n    directory=False,\n    #   Option 2: (creating any file extension)\n    #   -   string format:\n    data=\"\",\n    #   Options:\n    #   -   integer format:\n    permission=None,\n    #   -   string format:\n    owner=None,\n    group=None,\n    #   -   boolean format:\n    sudo=False, )\n\n```\n##### check:\n``` python\n\n# call file_path.check.\n_ = file_path.check(\n    #   Option 1: (creating a directory)\n    #   -   boolean format:\n    directory=False,\n    #   Option 2: (creating any file extension)\n    #   -   string format:\n    data=\"\",\n    #   Options:\n    #   -   integer format:\n    permission=None,\n    #   -   string format:\n    owner=None,\n    group=None,\n    #   -   boolean format:\n    sudo=False,\n    silent=False,\n    recursive=False, # for directories only (for permission \u0026 ownership check) )\n\n```\n##### split:\n``` python\n\n# call file_path.split.\n_ = file_path.split(path)\n\n```\n##### count:\n``` python\n\n# call file_path.count.\n_ = file_path.count(path)\n\n```\n##### replace:\n``` python\n\n# call file_path.replace.\n_ = file_path.replace(from_, to_)\n\n```\n##### lower:\n``` python\n\n# call file_path.lower.\n_ = file_path.lower(path)\n\n```\n##### upper:\n``` python\n\n# call file_path.upper.\n_ = file_path.upper(path)\n\n```\n##### instance:\n``` python\n\n# call file_path.instance.\n_ = file_path.instance()\n\n```\n##### assign:\n``` python\n\n# call file_path.assign.\n_ = file_path.assign(path, load=False)\n\n```\n##### raw:\n``` python\n\n# call file_path.raw.\n_ = file_path.raw()\n\n```\n\n## Ownership:\nThe ownership object class.\n``` python \n\n# initialize the FilePath.Ownership object class.\nownership = FilePath.Ownership(path=None, load=False)\n\n```\n\n#### Functions:\n\n##### get:\n``` python\n\n# call ownership.get.\n_ = ownership.get(path=None)\n\n```\n##### set:\n``` python\n\n# call ownership.set.\n_ = ownership.set(\n    # the permission (str) (#1).\n    owner=None,\n    # the group (str) (optional) (#2).\n    group=None,\n    # the path (optional) (overwrites ownership.path) (#3).\n    path=None,\n    # root permission required.\n    sudo=False,\n    # recursive.\n    recursive=False,\n    # silent.\n    silent=False, )\n\n```\n##### check:\n``` python\n\n# call ownership.check.\n_ = ownership.check(owner=None, group=None, sudo=False, silent=False, iterate=False, recursive=False, path=None)\n\n```\n\n## Permission:\nThe permission object class.\n``` python \n\n# initialize the FilePath.Permission object class.\npermission = FilePath.Permission(path=None, load=False)\n\n```\n\n#### Functions:\n\n##### get:\n``` python\n\n# call permission.get.\n_ = permission.get(path=None)\n\n```\n##### set:\n``` python\n\n# call permission.set.\n_ = permission.set(\n    # the permission (int) (#1).\n    permission=None,\n    # the path (optional) (overwrites permission.path) (#2).\n    path=None,\n    # root permission required.\n    sudo=False,\n    # recursive.\n    recursive=False,\n    # silent.\n    silent=False, )\n\n```\n##### check:\n``` python\n\n# call permission.check.\n_ = permission.check(permission=None, sudo=False, silent=False, iterate=False, recursive=False, path=None)\n\n```\n\n## String:\nThe string object class.\n``` python \n\n# initialize the String object class.\nstring = String(\n    # the string's value (str) (#1).\n    string=\"\",\n    # the path (str, FilePath) (param #2).\n    path=False,\n    # load the data on initialization.\n    load=False,\n    # the default array (will be created if file path does not exist).\n    default=None, )\n\n```\n\n#### Functions:\n\n##### save:\n``` python\n\n# call string.save.\n_ = string.save(string=None, path=None, sudo=False)\n\n```\n##### load:\n``` python\n\n# call string.load.\n_ = string.load(default=None, sudo=False)\n\n```\n##### is_numerical:\n``` python\n\n# call string.is_numerical.\n_ = string.is_numerical()\n\n```\n##### bash:\n``` python\n\n# call string.bash.\n_ = string.bash()\n\n```\n##### identifier:\n``` python\n\n# call string.identifier.\n_ = string.identifier()\n\n```\n##### variable_format:\n``` python\n\n# call string.variable_format.\n_ = string.variable_format(\n    exceptions={\n        \"smart_card\":\"smartcard\",\n        \"smart_cards\":\"smartcards\" ,\n        \"web_server\":\"webserver\" ,\n    }, )\n\n```\n##### class_format:\n``` python\n\n# call string.class_format.\n_ = string.class_format()\n\n```\n##### capitalized_scentence:\n``` python\n\n# call string.capitalized_scentence.\n_ = string.capitalized_scentence()\n\n```\n##### capitalized_word:\n``` python\n\n# call string.capitalized_word.\n_ = string.capitalized_word()\n\n```\n##### generate:\n``` python\n\n# call string.generate.\n_ = string.generate(\n    # the length of the generated string.\n    length=6,\n    # include digits.\n    digits=False,\n    # include capital letters.\n    capitalize=False,\n    # include special characters.\n    special=False, )\n\n```\n##### first_occurence:\n``` python\n\n# call string.first_occurence.\n_ = string.first_occurence(charset=[\" \", \"\\n\"], reversed=False, string=None)\n\n```\n##### before_after_first_occurence:\n``` python\n\n# call string.before_after_first_occurence.\n_ = string.before_after_first_occurence(slicer=\" \", include=True, include_before=False, include_after=False, string=None)\n\n```\n##### before_selected_after_first_occurence:\n``` python\n\n# call string.before_selected_after_first_occurence.\n_ = string.before_selected_after_first_occurence(slicer=\" \", string=None)\n\n```\n##### before_after_last_occurence:\n``` python\n\n# call string.before_after_last_occurence.\n_ = string.before_after_last_occurence(slicer=\" \", include=True, include_before=False, include_after=False, string=None)\n\n```\n##### before_selected_after_last_occurence:\n``` python\n\n# call string.before_selected_after_last_occurence.\n_ = string.before_selected_after_last_occurence(slicer=\" \", string=None)\n\n```\n##### between:\n``` python\n\n# call string.between.\n_ = string.between(identifiers=[\"{\",\"}\"], depth=1, include=True, string=None)\n\n```\n##### replace_between:\n``` python\n\n# call string.replace_between.\n_ = string.replace_between(\n    # the between identifiers (list) (#1).\n    identifiers=[\"{\",\"}\"],\n    # the new string (str) (#2).\n    to=\"\",\n    # the identifiers depth.\n    depth=1,\n    # the optional string.\n    string=None, )\n\n```\n##### increase_version:\n``` python\n\n# call string.increase_version.\n_ = string.increase_version()\n\n```\n##### slice_dict:\n``` python\n\n# call string.slice_dict.\n_ = string.slice_dict(depth=1)\n\n```\n##### slice_array:\n``` python\n\n# call string.slice_array.\n_ = string.slice_array(depth=1)\n\n```\n##### slice_tuple:\n``` python\n\n# call string.slice_tuple.\n_ = string.slice_tuple(depth=1)\n\n```\n##### indent:\n``` python\n\n# call string.indent.\n_ = string.indent(indent=4)\n\n```\n##### line_indent:\n``` python\n\n# call string.line_indent.\n_ = string.line_indent(line=\"\")\n\n```\n##### slice_indent:\n``` python\n\n# call string.slice_indent.\n_ = string.slice_indent(indent=4, depth=1, string=None, remove_indent=True)\n\n```\n##### first:\n``` python\n\n# call string.first.\n_ = string.first(count)\n\n```\n##### last:\n``` python\n\n# call string.last.\n_ = string.last(count)\n\n```\n##### remove_first:\n``` python\n\n# call string.remove_first.\n_ = string.remove_first(count)\n\n```\n##### remove_last:\n``` python\n\n# call string.remove_last.\n_ = string.remove_last(count)\n\n```\n##### split:\n``` python\n\n# call string.split.\n_ = string.split(string)\n\n```\n##### count:\n``` python\n\n# call string.count.\n_ = string.count(string)\n\n```\n##### replace:\n``` python\n\n# call string.replace.\n_ = string.replace(from_, to_)\n\n```\n##### lower:\n``` python\n\n# call string.lower.\n_ = string.lower(string)\n\n```\n##### upper:\n``` python\n\n# call string.upper.\n_ = string.upper(string)\n\n```\n##### instance:\n``` python\n\n# call string.instance.\n_ = string.instance()\n\n```\n##### assign:\n``` python\n\n# call string.assign.\n_ = string.assign(string)\n\n```\n##### raw:\n``` python\n\n# call string.raw.\n_ = string.raw()\n\n```\n\n## Boolean:\nThe boolean object class.\n``` python \n\n# initialize the Boolean object class.\nboolean = Boolean(\n    # the boolean's value (bool) (#1).\n    boolean=False,\n    # the path (str, FilePath) (param #2).\n    path=False,\n    # load the data on initialization.\n    load=False,\n    # the default array (will be created if file path does not exist).\n    default=None, )\n\n```\n\n#### Functions:\n\n##### save:\n``` python\n\n# call boolean.save.\n_ = boolean.save(bool=None, path=None, sudo=False)\n\n```\n##### load:\n``` python\n\n# call boolean.load.\n_ = boolean.load(default=None, sudo=False)\n\n```\n##### string:\n``` python\n\n# call boolean.string.\n_ = boolean.string(true=\"True\", false=\"False\")\n\n```\n##### instance:\n``` python\n\n# call boolean.instance.\n_ = boolean.instance()\n\n```\n##### assign:\n``` python\n\n# call boolean.assign.\n_ = boolean.assign(boolean)\n\n```\n##### raw:\n``` python\n\n# call boolean.raw.\n_ = boolean.raw()\n\n```\n\n## Integer:\nThe integer object class.\n``` python \n\n# initialize the Integer object class.\ninteger = Integer(\n    # the integers value (int, float) (param #1).\n    value=0,\n    # the path (str, FilePath) (param #2).\n    path=False,\n    # the integer format (str) (param #3).\n    format=\"auto\",\n    # load the data on initialization.\n    load=False,\n    # the default array (will be created if file path does not exist).\n    default=None, )\n\n```\n\n#### Functions:\n\n##### save:\n``` python\n\n# call integer.save.\n_ = integer.save(data=None, path=None, sudo=False)\n\n```\n##### load:\n``` python\n\n# call integer.load.\n_ = integer.load(default=None, sudo=False)\n\n```\n##### increase_version:\n``` python\n\n# call integer.increase_version.\n_ = integer.increase_version()\n\n```\n##### round:\n``` python\n\n# call integer.round.\n_ = integer.round(decimals)\n\n```\n##### round_down:\n``` python\n\n# call integer.round_down.\n_ = integer.round_down(decimals)\n\n```\n##### generate:\n``` python\n\n# call integer.generate.\n_ = integer.generate(length=6)\n\n```\n##### instance:\n``` python\n\n# call integer.instance.\n_ = integer.instance()\n\n```\n##### assign:\n``` python\n\n# call integer.assign.\n_ = integer.assign(value)\n\n```\n##### raw:\n``` python\n\n# call integer.raw.\n_ = integer.raw()\n\n```\n\n## Date:\nThe date object class.\n``` python \n\n# initialize the Date object class.\ndate = Date(\n    #\n    # Leave all parameters None to initialize a Date() object with the current date.\n    # Pass another Date object, str repr or timestamp in seconds to initialize a Date object from that timestamp.\n    #\n    # the date parameter (str, int, Date) (optional) (#1).\n    date=None, )\n\n```\n\n#### Functions:\n\n##### initialize:\n``` python\n\n# call date.initialize.\n_ = date.initialize(\n    #\n    # Leave all parameters None to initialize a Date() object with the current date.\n    #\n    # Initialize a future / previous date.\n    #   option 1:\n    #     specify the timestamp to initialize a previous / future date (format required).\n    timestamp=None,\n    #     the timestamp format (leave None to parse).\n    format=None,\n    #   options 2:\n    #     initialize by seconds.\n    seconds=None, )\n\n```\n##### compare:\n``` python\n\n# call date.compare.\n_ = date.compare(comparison=None, current=None, format=None)\n\n```\n##### increase:\n``` python\n\n# call date.increase.\n_ = date.increase(string, weeks=0, days=0, hours=0, minutes=0, seconds=0, format=None)\n\n```\n##### decrease:\n``` python\n\n# call date.decrease.\n_ = date.decrease(string, weeks=0, days=0, hours=0, minutes=0, seconds=0, format=None)\n\n```\n##### to_seconds:\n``` python\n\n# call date.to_seconds.\n_ = date.to_seconds(string, format=None)\n\n```\n##### from_seconds:\n``` python\n\n# call date.from_seconds.\n_ = date.from_seconds(seconds, format=None)\n\n```\n##### convert:\n``` python\n\n# call date.convert.\n_ = date.convert(string, input=\"%d-%m-%y %H:%M\", output=\"%Y%m%d\")\n\n```\n##### parse_format:\n``` python\n\n# call date.parse_format.\n_ = date.parse_format(string)\n\n```\n##### assign:\n``` python\n\n# call date.assign.\n_ = date.assign(string, format=None)\n\n```\n##### instance:\n``` python\n\n# call date.instance.\n_ = date.instance()\n\n```\n\n## Generate:\nThe generate object class.\n``` python \n\n# initialize the Generate object class.\ngenerate = Generate()\n\n```\n\n#### Functions:\n\n##### int:\n``` python\n\n# call generate.int.\n_ = generate.int(length=6)\n\n```\n##### string:\n``` python\n\n# call generate.string.\n_ = generate.string(length=6, capitalize=True, digits=True)\n\n```\n\n## Interval:\nThe interval object class.\n``` python \n\n# initialize the Interval object class.\ninterval = Interval(\n    # the sleep time.\n    sleeptime=1,\n    # the timeout.\n    timeout=60, )\n\n```\n\n#### Functions:\n\n##### sleep:\n``` python\n\n# call interval.sleep.\n_ = interval.sleep(chapters=1)\n\n```\n\n## File:\nThe file object class.\n``` python \n\n# initialize the File object class.\nfile = File(path=None, data=None, load=False, default=None)\n\n```\n\n#### Functions:\n\n##### load:\n``` python\n\n# call file.load.\n_ = file.load(default=None, sudo=False)\n\n```\n##### load_line:\n``` python\n\n# call file.load_line.\n_ = file.load_line(line_number, default=None, sudo=False)\n\n```\n##### save:\n``` python\n\n# call file.save.\n_ = file.save(data=None, path=None, overwrite_duplicates=True, sudo=False)\n\n```\n##### check:\n``` python\n\n# call file.check.\n_ = file.check(default=None, save=True)\n\n```\n##### instance:\n``` python\n\n# call file.instance.\n_ = file.instance()\n\n```\n##### assign:\n``` python\n\n# call file.assign.\n_ = file.assign(data)\n\n```\n##### raw:\n``` python\n\n# call file.raw.\n_ = file.raw()\n\n```\n\n## Array:\nThe array object class.\n``` python \n\n# initialize the Array object class.\narray = Array(\n    # the array (param #1).\n    array=[],\n    # the path (param #2).\n    path=False,\n    # load the data on initialization.\n    load=False,\n    # the default array (will be created if file path does not exist).\n    default=None, )\n\n```\n\n#### Functions:\n\n##### save:\n``` python\n\n# call array.save.\n_ = array.save(array=None, path=None, ensure_ascii=False, indent=4, sudo=False)\n\n```\n##### load:\n``` python\n\n# call array.load.\n_ = array.load(default=None, sudo=False)\n\n```\n##### string:\n``` python\n\n# call array.string.\n_ = array.string(joiner=\" \", sum_first=False)\n\n```\n##### divide:\n``` python\n\n# call array.divide.\n_ = array.divide(into=2)\n\n```\n##### remove:\n``` python\n\n# call array.remove.\n_ = array.remove(indexes=[], values=[], update=True, save=False)\n\n```\n##### append:\n``` python\n\n# call array.append.\n_ = array.append(var)\n\n```\n##### pop:\n``` python\n\n# call array.pop.\n_ = array.pop(index)\n\n```\n##### count:\n``` python\n\n# call array.count.\n_ = array.count(item=None)\n\n```\n##### check:\n``` python\n\n# call array.check.\n_ = array.check(default=None, save=True)\n\n```\n##### clean:\n``` python\n\n# call array.clean.\n_ = array.clean(\n    # the string replacements.\n    #    example:\n    #        { \"Hello\":\"hello\" }\n    #        [ [\"Hello\", \"hello\"] ]\n    replacements={},\n    # the first characters to remove (String \u0026 Array).\n    remove_first=[],\n    # the last characters to remove (String \u0026 Array).\n    remove_last=[],\n    # the first characters that are ensured (String \u0026 Array) (List: check is one of the list is ensured).\n    ensure_first=[],\n    # the last characters that are ensured (String \u0026 Array) (List: check is one of the list is ensured).\n    ensure_last=[],\n    # remove all values within the list from the array.\n    remove_values=[],\n    # update the self array.\n    update=True,\n    # the dicionary (leave None to use array.array).\n    array=None, )\n\n```\n##### iterate:\n``` python\n\n# call array.iterate.\n_ = array.iterate(sorted=False, reversed=False, array=None)\n\n```\n##### items:\n``` python\n\n# call array.items.\n_ = array.items(sorted=False, reversed=False, array=None)\n\n```\n##### keys:\n``` python\n\n# call array.keys.\n_ = array.keys(sorted=False, reversed=False, array=None)\n\n```\n##### reversed:\n``` python\n\n# call array.reversed.\n_ = array.reversed(array=None)\n\n```\n##### sort:\n``` python\n\n# call array.sort.\n_ = array.sort(alphabetical=True, ascending=False, reversed=False, array=None)\n\n```\n##### json:\n``` python\n\n# call array.json.\n_ = array.json(sorted=False, reversed=False, indent=4, array=None, )\n\n```\n##### serialize:\n``` python\n\n# call array.serialize.\n_ = array.serialize(sorted=False, reversed=False, json=False, array=None)\n\n```\n##### instance:\n``` python\n\n# call array.instance.\n_ = array.instance()\n\n```\n##### assign:\n``` python\n\n# call array.assign.\n_ = array.assign(array, save=False)\n\n```\n##### raw:\n``` python\n\n# call array.raw.\n_ = array.raw()\n\n```\n\n## Dictionary:\nThe dictionary object class.\n``` python \n\n# initialize the Dictionary object class.\ndictionary = Dictionary(\n    # the dictionary (param #1).\n    dictionary={},\n    # the file path (param #2).\n    path=False,\n    # load the file path dictionary on init.\n    load=False,\n    # specify default to check \u0026 create the dict.\n    default=None, )\n\n```\n\n#### Functions:\n\n##### save:\n``` python\n\n# call dictionary.save.\n_ = dictionary.save(dictionary=None, path=None, ensure_ascii=False, indent=4, sudo=False)\n\n```\n##### load:\n``` python\n\n# call dictionary.load.\n_ = dictionary.load(default=None, sudo=False)\n\n```\n##### load_line:\n``` python\n\n# call dictionary.load_line.\n_ = dictionary.load_line(line_number, sudo=False)\n\n```\n##### check:\n``` python\n\n# call dictionary.check.\n_ = dictionary.check(\n    #   Option 1:\n    key=None, # check a certain key, it appends if not present\n    value=None, # check a certain key, append the value if not present (no format check)\n    #   Option 2:\n    default=None, # check based on a default dictionary, it appends it not present.\n    #   Optionals:\n    dictionary=None, # overwrite the start dictionary, leave None to use dictionary.dictionary.\n    save=False, # saves the output \u0026 and sets the output to dictionary.dictionary. )\n\n```\n##### divide:\n``` python\n\n# call dictionary.divide.\n_ = dictionary.divide(into=2)\n\n```\n##### append:\n``` python\n\n# call dictionary.append.\n_ = dictionary.append(\n    # by default it only overwrites if a key does not exist and sums the key if it is a str / int.\n    #\n    # a dictionary to append.\n    dictionary,\n    # the overwrite formats (add \"*\" for all).\n    overwrite=[],\n    # the sum formats (add \"*\" for all).\n    sum=[\"int\", \"float\"],\n    # the banned dictionary keys.\n    banned=[],\n    # update the self dict.\n    update=True,\n    # save the new dict.\n    save=False,\n    # do not use.\n    dictionary_=None, )\n\n```\n##### edit:\n``` python\n\n# call dictionary.edit.\n_ = dictionary.edit(\n    # the dictionary (leave None to use dictionary.dictionary).\n    dictionary=None,\n    # the edits (dict).\n    #     adds / replaces the current (except the exceptions).\n    edits={},\n    # the edits key Exceptions.\n    exceptions=[],\n    # the edits value Exceptions.\n    value_exceptions=[None],\n    # the instances to overwrite (list[str]) (missing stands for the keys that are missing in the dictionary).\n    overwite=[\"missing\"],\n    # the instances to combine (list[str]) (dict is always recursive).\n    combine=[\"int\", \"float\", \"Integer\", \"list\", \"Array\"],\n    # save the edits.\n    save=True,\n    # the log level.\n    log_level=-1, )\n\n```\n##### unpack:\n``` python\n\n# call dictionary.unpack.\n_ = dictionary.unpack(\n    # the key / keys / defaults parameter (#1).\n    # str instance:\n    #   unpack the str key\n    # list instance:\n    #   unpack all keys in the list.\n    # dict instance:\n    #   unpack all keys from the dict \u0026 when not present return the key's value as default.\n    keys, )\n\n```\n##### remove:\n``` python\n\n# call dictionary.remove.\n_ = dictionary.remove(keys=[], values=[], update=True, save=False, dictionary=None)\n\n```\n##### count:\n``` python\n\n# call dictionary.count.\n_ = dictionary.count(item=None, values=False)\n\n```\n##### insert:\n``` python\n\n# call dictionary.insert.\n_ = dictionary.insert(dictionary={})\n\n```\n##### iterate:\n``` python\n\n# call dictionary.iterate.\n_ = dictionary.iterate(sorted=False, reversed=False, dictionary=None)\n\n```\n##### items:\n``` python\n\n# call dictionary.items.\n_ = dictionary.items(sorted=False, reversed=False, dictionary=None)\n\n```\n##### keys:\n``` python\n\n# call dictionary.keys.\n_ = dictionary.keys(sorted=False, reversed=False, dictionary=None)\n\n```\n##### values:\n``` python\n\n# call dictionary.values.\n_ = dictionary.values(sorted=False, reversed=False, dictionary=None)\n\n```\n##### reversed:\n``` python\n\n# call dictionary.reversed.\n_ = dictionary.reversed(update=True, dictionary=None)\n\n```\n##### sort:\n``` python\n\n# call dictionary.sort.\n_ = dictionary.sort(alphabetical=True, ascending=False, reversed=False, update=True, dictionary=None)\n\n```\n##### json:\n``` python\n\n# call dictionary.json.\n_ = dictionary.json(sorted=False, reversed=False, indent=4, dictionary=None, )\n\n```\n##### serialize:\n``` python\n\n# call dictionary.serialize.\n_ = dictionary.serialize(sorted=False, reversed=False, json=False, dictionary=None)\n\n```\n##### instance:\n``` python\n\n# call dictionary.instance.\n_ = dictionary.instance(serialize=False)\n\n```\n##### assign:\n``` python\n\n# call dictionary.assign.\n_ = dictionary.assign(dictionary, save=False)\n\n```\n##### raw:\n``` python\n\n# call dictionary.raw.\n_ = dictionary.raw()\n\n```\n\n## Directory:\nThe directory object class.\n``` python \n\n# initialize the Directory object class.\ndirectory = Directory(\n    # the dirs file path (param #1).\n    path=None,\n    # the hierarchy to check / create.\n    hierarchy={},\n    # load the content.\n    #load=False,\n    # load recursive.\n    #recursive=False, )\n\n```\n\n#### Functions:\n\n##### create:\n``` python\n\n# call directory.create.\n_ = directory.create(file_paths=[], path=None, sudo=False, owner=None, group=None, permission=None)\n\n```\n##### delete:\n``` python\n\n# call directory.delete.\n_ = directory.delete(forced=False)\n\n```\n##### check:\n``` python\n\n# call directory.check.\n_ = directory.check(\n    #   Required:\n    #   -   dictionary format:\n    hierarchy=None,\n    #   Optionals:\n    #   -   string format:\n    owner=None,\n    group=None,\n    #   -   boolean format:\n    sudo=False,\n    #   -   integer format:\n    permission=None, # (octal format)\n    recursive=False, # for permission/ownership\n    silent=False, )\n\n```\n##### load:\n``` python\n\n# call directory.load.\n_ = directory.load(path=None, format=str, default=None, sudo=False)\n\n```\n##### save:\n``` python\n\n# call directory.save.\n_ = directory.save(path=None, data=None, format=str, sudo=False)\n\n```\n##### paths:\n``` python\n\n# call directory.paths.\n_ = directory.paths(\n    # get recursively (bool).\n    recursive=False,\n    # get files only (bool).\n    files_only=False,\n    # get firs only (bool).\n    dirs_only=False,\n    # also get empty dirs (bool).\n    empty_dirs=True,\n    # the banned full paths (list).\n    banned=[],\n    # the banned names (list).\n    banned_names=[\".DS_Store\"],\n    # the banend base names (list).\n    banned_basenames=[\"__pycache__\"],\n    # the allowed extensions (list).\n    extensions=[\"*\"],\n    # the path (leave None to use directory.path) (str, FilePath).\n    path=None, )\n\n```\n##### names:\n``` python\n\n# call directory.names.\n_ = directory.names(\n    # get recursively (bool).\n    recursive=False,\n    # get files only (bool).\n    files_only=False,\n    # get firs only (bool).\n    dirs_only=False,\n    # also get empty dirs (bool).\n    empty_dirs=True,\n    # remove the extension names (bool).\n    remove_extensions=False,\n    # the banned full paths (list).\n    banned=[],\n    # the banned names (list).\n    banned_names=[\".DS_Store\"],\n    # the banend base names (list).\n    banned_basenames=[\"__pycache__\"],\n    # the allowed extensions (list).\n    extensions=[\"*\"],\n    # the path (leave None to use directory.path) (str, FilePath).\n    path=None, )\n\n```\n##### oldest:\n``` python\n\n# call directory.oldest.\n_ = directory.oldest()\n\n```\n##### newest:\n``` python\n\n# call directory.newest.\n_ = directory.newest()\n\n```\n##### random:\n``` python\n\n# call directory.random.\n_ = directory.random()\n\n```\n##### generate:\n``` python\n\n# call directory.generate.\n_ = directory.generate(length=24, type=\"/\")\n\n```\n##### structured_join:\n``` python\n\n# call directory.structured_join.\n_ = directory.structured_join(name, type=\"\", structure=\"alphabetical\", create_base=False, sudo=False, owner=None, group=None, permission=None)\n\n```\n##### contains:\n``` python\n\n# call directory.contains.\n_ = directory.contains(name=None, type=\"/\", recursive=False)\n\n```\n##### subpath:\n``` python\n\n# call directory.subpath.\n_ = directory.subpath(fullpath)\n\n```\n##### fullpath:\n``` python\n\n# call directory.fullpath.\n_ = directory.fullpath(subpath)\n\n```\n##### set_icon:\n``` python\n\n# call directory.set_icon.\n_ = directory.set_icon(\n    # the path to the .png / .jpg icon.\n    icon=None,\n    # the directory path (leave None to use directory.fp.path).\n    path=None, )\n\n```\n##### index:\n``` python\n\n# call directory.index.\n_ = directory.index(\n    # the wanted options.\n    metrics=[],\n    options=[\"size\", \"mtime\", \"content\", \"name\", \"basename\", \"extension\", \"mount\", \"directory\"],\n    # optional path (leave None to use directory.path).\n    path=None, )\n\n```\n##### open:\n``` python\n\n# call directory.open.\n_ = directory.open(path=None, sudo=False)\n\n```\n##### find:\n``` python\n\n# call directory.find.\n_ = directory.find(matches:list, path=None, recursive=False, log_level=0)\n\n```\n##### replace:\n``` python\n\n# call directory.replace.\n_ = directory.replace(replacements:list, path=None, recursive=False, log_level=0)\n\n```\n##### join:\n``` python\n\n# call directory.join.\n_ = directory.join(name=None, type=\"\")\n\n```\n##### name:\n``` python\n\n# call directory.name.\n_ = directory.name()\n\n```\n##### base:\n``` python\n\n# call directory.base.\n_ = directory.base()\n\n```\n##### basename:\n``` python\n\n# call directory.basename.\n_ = directory.basename()\n\n```\n##### instance:\n``` python\n\n# call directory.instance.\n_ = directory.instance()\n\n```\n##### raw:\n``` python\n\n# call directory.raw.\n_ = directory.raw()\n\n```\n\n## Image:\nThe image object class.\n``` python \n\n# initialize the Image object class.\nimage = Image(path=None, image=None, load=False)\n\n```\n\n#### Functions:\n\n##### load:\n``` python\n\n# call image.load.\n_ = image.load(path=None)\n\n```\n##### edit_pixel:\n``` python\n\n# call image.edit_pixel.\n_ = image.edit_pixel(pixel=[0, 0], new_pixel_tuple=None)\n\n```\n##### convert:\n``` python\n\n# call image.convert.\n_ = image.convert(input='logo.png', output='logo.ico')\n\n```\n##### replace_pixels:\n``` python\n\n# call image.replace_pixels.\n_ = image.replace_pixels(input_path=None, output_path=None, input_hex=None, output_hex=None)\n\n```\n##### replace_colors:\n``` python\n\n# call image.replace_colors.\n_ = image.replace_colors(input_path=None, output_path=None, hex=None)\n\n```\n##### rgb_to_hex:\n``` python\n\n# call image.rgb_to_hex.\n_ = image.rgb_to_hex(tuple)\n\n```\n##### hex_to_rgb:\n``` python\n\n# call image.hex_to_rgb.\n_ = image.hex_to_rgb(_hex_)\n\n```\n##### instance:\n``` python\n\n# call image.instance.\n_ = image.instance()\n\n```\n##### raw:\n``` python\n\n# call image.raw.\n_ = image.raw()\n\n```\n\n## Zip:\nThe zip object class.\n``` python \n\n# initialize the Zip object class.\nzip = Zip(path=None, check=False)\n\n```\n\n#### Functions:\n\n##### create:\n``` python\n\n# call zip.create.\n_ = zip.create(\n    # source can either be a string or an array.\n    source=None,\n    # remove the source file(s).\n    remove=False,\n    # sudo required to move/copy source files.\n    sudo=False, )\n\n```\n##### extract:\n``` python\n\n# call zip.extract.\n_ = zip.extract(\n    # the base extract directory.\n    base=None,\n    # remove the zip after extraction.\n    remove=False,\n    # if sudo required for removing file path.\n    sudo=False,)\n\n```\n##### instance:\n``` python\n\n# call zip.instance.\n_ = zip.instance()\n\n```\n##### raw:\n``` python\n\n# call zip.raw.\n_ = zip.raw()\n\n```\n\n## Bytes:\nThe bytes object class.\n``` python \n\n# initialize the Bytes object class.\nbytes = Bytes(\n    # the bytes (param #1).\n    data=b\"\",\n    # the path (str, FilePath) (param #2).\n    path=False,\n    # load the data on initialization.\n    load=False,\n    # the default array (will be created if file path does not exist).\n    default=None, )\n\n```\n\n#### Functions:\n\n##### load:\n``` python\n\n# call bytes.load.\n_ = bytes.load(sudo=False)\n\n```\n##### save:\n``` python\n\n# call bytes.save.\n_ = bytes.save(bytes=None, sudo=False)\n\n```\n##### instance:\n``` python\n\n# call bytes.instance.\n_ = bytes.instance()\n\n```\n##### assign:\n``` python\n\n# call bytes.assign.\n_ = bytes.assign(b)\n\n```\n##### raw:\n``` python\n\n# call bytes.raw.\n_ = bytes.raw()\n\n```\n\n## Color:\nThe color object class.\n``` python \n\n# import the color object class.\nimport dev0s\n\n```\n\n#### Functions:\n\n##### remove:\n``` python\n\n# call color.remove.\n_ = color.remove(string)\n\n```\n##### fill:\n``` python\n\n# call color.fill.\n_ = color.fill(string)\n\n```\n##### boolean:\n``` python\n\n# call color.boolean.\n_ = color.boolean(boolean, red=True)\n\n```\n\n## Symbol:\nThe symbol object class.\n``` python \n\n# import the symbol object class.\nimport dev0s\n\n```\n## Defaults:\nThe defaults object class.\n``` python \n\n# import the dev0s.defaults object class.\nimport dev0s\n\n```\n\n#### Functions:\n\n##### operating_system:\n``` python\n\n# call defaults.operating_system.\n_ = defaults.operating_system(supported=[\"*\"])\n\n```\n##### alias:\n``` python\n\n# call defaults.alias.\n_ = defaults.alias(\n    # the source name.\n    alias=None,\n    # the source path.\n    executable=None,\n    # can use sudo.\n    sudo=False,\n    # overwrite.\n    overwrite=False,\n    # the venv path (leave None to ignore).\n    venv=None, )\n\n```\n##### source_path:\n``` python\n\n# call defaults.source_path.\n_ = defaults.source_path(path, back=1)\n\n```\n##### log_level:\n``` python\n\n# call defaults.log_level.\n_ = defaults.log_level(default=0)\n\n```\n##### pwd:\n``` python\n\n# call defaults.pwd.\n_ = defaults.pwd()\n\n```\n##### insert:\n``` python\n\n# call defaults.insert.\n_ = defaults.insert(path)\n\n```\n##### site_packages:\n``` python\n\n# call defaults.site_packages.\n_ = defaults.site_packages()\n\n```\n##### install_requirements:\n``` python\n\n# call defaults.install_requirements.\n_ = defaults.install_requirements(\n    # the requirements (#1).\n    #    str instance: path to file.\n    #    list instance: pip requirements in list\n    requirements,\n    # the silent option.\n    silent=False,\n    # the log level (Leave None to use defaults.options.log_level).\n    log_level=None, )\n\n```\n##### interactive:\n``` python\n\n# call defaults.interactive.\n_ = defaults.interactive(default=False)\n\n```\n\n## Traceback:\nThe traceback object class.\n``` python \n\n# initialize the Traceback object class.\ntraceback = Traceback(\n    # the imported traceback (#1).\n    traceback=\"Traceback\",\n    # the raw traceback (#2).\n    raw_traceback=\"Object\", )\n\n```\n#### Properties:\n```python\n\n# the traceback property.\ntraceback = traceback.traceback\n```\n\n## Object:\nThe object object class.\n``` python \n\n# initialize the Object object class.\nobject = Object(\n    # attributes (dict) (#1)\n    attributes={},\n    # the imported traceback.\n    traceback=\"Object\",\n    # the raw traceback.\n    raw_traceback=\"Object\", )\n\n```\n\n#### Functions:\n\n##### items:\n``` python\n\n# call object.items.\n_ = object.items(\n    # the keys to get (leave default to unpack all keys).\n    #    list instance: checks if the key is present if not it throws an error when [safe] is disabled\n    #    dict instance: automatically enables [safe] and returns the key's value as default when missing.\n    keys=[\"*\"],\n    # with safe disabled it throws an error when one of the specified keys does not exist.\n    safe=True, )\n\n```\n##### keys:\n``` python\n\n# call object.keys.\n_ = object.keys(\n    # the keys to get (leave default to unpack all keys).\n    #    list instance: checks if the key is present if not it throws an error when [safe] is disabled\n    #    dict instance: automatically enables [safe] and returns the key's value as default when missing.\n    keys=[\"*\"],\n    # with safe disabled it throws an error when one of the specified keys does not exist.\n    safe=True, )\n\n```\n##### values:\n``` python\n\n# call object.values.\n_ = object.values()\n\n```\n##### assign:\n``` python\n\n# call object.assign.\n_ = object.assign(\n    # the dictionary to self assign.\n    dictionary,\n    # serialize dictionary from str to object.\n    serialize=True,\n    # the keys to get from the dict (leave default to unpack the present keys).\n    #    list instance: checks if the key is present if not it throws an error when [safe] is disabled\n    #    dict instance: automatically enables [safe] and returns the key's value as default when missing.\n    keys=[\"*\"],\n    # with safe disabled it throws an error when one of the specified keys does not exist.\n    safe=True, )\n\n```\n##### attributes:\n``` python\n\n# call object.attributes.\n_ = object.attributes(\n    # the keys to get (leave default to unpack all keys).\n    #    list instance: checks if the key is present if not it throws an error when [safe] is disabled\n    #    dict instance: automatically enables [safe] and returns the key's value as default when missing.\n    keys=[\"*\"],\n    # with safe disabled it throws an error when one of the specified keys does not exist.\n    safe=True, )\n\n```\n##### dict:\n``` python\n\n# call object.dict.\n_ = object.dict(\n    # the keys to get (leave default to unpack all keys).\n    #    list instance: checks if the key is present if not it throws an error when [safe] is disabled\n    #    dict instance: automatically enables [safe] and returns the key's value as default when missing.\n    keys=[\"*\"],\n    # with safe disabled it throws an error when one of the specified keys does not exist.\n    safe=True, )\n\n```\n##### unpack:\n``` python\n\n# call object.unpack.\n_ = object.unpack(\n    # the key / keys / defaults parameter (#1).\n    # str instance:\n    #   unpack the str key\n    # list instance:\n    #   unpack all keys in the list.\n    # dict instance:\n    #   unpack all keys from the dict \u0026 when not present return the key's value as default.\n    keys, )\n\n```\n\n## Thread:\nThe thread object class.\n``` python \n\n# initialize the Thread object class.\nthread = Thread(\n    # the threads id (#1).\n    id=\"Thread\",\n    # the imported traceback.\n    traceback=\"Thread\",\n    # the raw traceback.\n    raw_traceback=\"Thread\",\n    # the threads log level.\n    log_level=-1, )\n\n```\n\n#### Functions:\n\n##### run:\n``` python\n\n# call thread.run.\n_ = thread.run()\n\n```\n##### safe_start:\n``` python\n\n# call thread.safe_start.\nresponse = thread.safe_start(timeout=120, sleeptime=1)\n\n```\n##### safe_stop:\n``` python\n\n# call thread.safe_stop.\nresponse = thread.safe_stop(timeout=120, sleeptime=1)\n\n```\n##### send_stop:\n``` python\n\n# call thread.send_stop.\n_ = thread.send_stop(\n    # all optional.\n    # option 1: the success message.\n    message=None, # (1)\n    args={}, # (2)\n    # option 2: the error message.\n    error=None,\n    # option 3: the response object.\n    response=None,\n    # save the message/error/response.\n    save=False,\n    # the active log level (int) (leave None to use thread.log_level).\n    log_level=None,\n    # the required log level for when to print to console (leave None to use _response_.log_level ; default: 0).\n    required_log_level=_response_.log_level, )\n\n```\n##### send_crash:\n``` python\n\n# call thread.send_crash.\n_ = thread.send_crash(\n    # all optional.\n    # option 1: the success message.\n    message=None, # (1)\n    args={}, # (2)\n    # option 2: the error message.\n    error=None,\n    # option 3: the response object.\n    response=None,\n    # save the message/error/response.\n    save=False,\n    # the active log level (int) (leave None to use thread.log_level).\n    log_level=None,\n    # the required log level for when to print to console (leave None to use _response_.log_level ; default: 0).\n    required_log_level=_response_.log_level, )\n\n```\n##### log:\n``` python\n\n# call thread.log.\nresponse = thread.log(\n    # option 1:\n    # the message (#1 param).\n    message=None,\n    # option 2:\n    # the error.\n    error=None,\n    # option 3:\n    # the response dict (leave message None to use).\n    response={},\n    # print the response as json.\n    json=JSON,\n    # optionals:\n    # the active log level (leave None to use thread.log_level).\n    log_level=None,\n    # the required log level for when printed to console.\n    required_log_level=0,\n    # save to log file.\n    save=False,\n    # save errors always (for options 2 \u0026 3 only).\n    save_errors=None,\n    # the log mode (leave None for default).\n    mode=None, )\n\n```\n\n#### Properties:\n```python\n\n# the run permission property.\nrun_permission = thread.run_permission\n```\n```python\n\n# the running property.\nrunning = thread.running\n```\n```python\n\n# the stopped property.\nstopped = thread.stopped\n```\n```python\n\n# the crashed property.\ncrashed = thread.crashed\n```\n```python\n\n# the response property.\nresponse = thread.response\n```\n\n## AES:\nThe aes object class.\n``` python \n\n# initialize the dev0s.encryption.AES object class.\naes = dev0s.encryption.AES(passphrase=None)\n\n```\n\n#### Functions:\n\n##### encrypt:\n``` python\n\n# call aes.encrypt.\nresponse = aes.encrypt(raw)\n\n```\n##### decrypt:\n``` python\n\n# call aes.decrypt.\nresponse = aes.decrypt(enc)\n\n```\n##### get_key:\n``` python\n\n# call aes.get_key.\nresponse = aes.get_key(salt=None)\n\n```\n##### generate_salt:\n``` python\n\n# call aes.generate_salt.\nresponse = aes.generate_salt()\n\n```\n\n## AsymmetricAES:\nThe asymmetricaes object class.\n``` python \n\n# initialize the dev0s.encryption.AsymmetricAES object class.\nasymmetricaes = dev0s.encryption.AsymmetricAES(\n    # the public key (str).\n    public_key=None,\n    # the private key (str).\n    private_key=None,\n    # the key passphrase (str / null).\n    passphrase=None,\n    # enable memory when the keys are not saved.\n    memory=False, )\n\n```\n\n#### Functions:\n\n##### generate_keys:\n``` python\n\n# call asymmetricaes.generate_keys.\n_ = asymmetricaes.generate_keys()\n\n```\n##### load_keys:\n``` python\n\n# call asymmetricaes.load_keys.\n_ = asymmetricaes.load_keys()\n\n```\n##### load_private_key:\n``` python\n\n# call asymmetricaes.load_private_key.\n_ = asymmetricaes.load_private_key()\n\n```\n##### load_public_key:\n``` python\n\n# call asymmetricaes.load_public_key.\n_ = asymmetricaes.load_public_key()\n\n```\n##### edit_passphrase:\n``` python\n\n# call asymmetricaes.edit_passphrase.\n_ = asymmetricaes.edit_passphrase(passphrase=None)\n\n```\n##### encrypt:\n``` python\n\n# call asymmetricaes.encrypt.\nresponse = asymmetricaes.encrypt(string, decode=False)\n\n```\n##### decrypt:\n``` python\n\n# call asymmetricaes.decrypt.\nresponse = asymmetricaes.decrypt(string, decode=False)\n\n```\n##### encrypt_file:\n``` python\n\n# call asymmetricaes.encrypt_file.\nresponse = asymmetricaes.encrypt_file(input=None, output=None, remove=False, base64_encoding=False)\n\n```\n##### decrypt_file:\n``` python\n\n# call asymmetricaes.decrypt_file.\nresponse = asymmetricaes.decrypt_file(input=None, output=None, remove=False, base64_encoding=False)\n\n```\n##### encrypt_directory:\n``` python\n\n# call asymmetricaes.encrypt_directory.\nresponse = asymmetricaes.encrypt_directory(input=None, output=None, remove=False)\n\n```\n##### decrypt_directory:\n``` python\n\n# call asymmetricaes.decrypt_directory.\nresponse = asymmetricaes.decrypt_directory(input=None, output=None, remove=False)\n\n```\n\n#### Properties:\n```python\n\n# the generated property.\ngenerated = asymmetricaes.generated\n```\n```python\n\n# the activated property.\nactivated = asymmetricaes.activated\n```\n```python\n\n# the public key activated property.\npublic_key_activated = asymmetricaes.public_key_activated\n```\n```python\n\n# the private key activated property.\nprivate_key_activated = asymmetricaes.private_key_activated\n```\n\n## Database:\nThe database object class.\n``` python \n\n# initialize the dev0s.encryption.Database object class.\ndatabase = dev0s.encryption.Database(\n    # the aes object class.\n    aes=None,\n    # the root path of the database.\n    path=None, )\n\n```\n\n#### Functions:\n\n##### activate:\n``` python\n\n# call database.activate.\nresponse = database.activate(\n    # the key;s passphrase (optional).\n    passphrase=None, )\n\n```\n##### check:\n``` python\n\n# call database.check.\nresponse = database.check(\n    # the subpath of the content (! param number 1).\n    path=None,\n    # the default content data (! param number 2).\n    default=None,\n    # save the changes.\n    save=True, )\n\n```\n##### load:\n``` python\n\n# call database.load.\nresponse = database.load(\n    # the subpath of the content (! param number 1).\n    path=None,\n    # the default data, specify to call database.check() automatically on the data object.\n    default=None, )\n\n```\n##### save:\n``` python\n\n# call database.save.\nresponse = database.save(\n    # the content object (! param number 1).\n    content=None, )\n\n```\n\n#### Properties:\n```python\n\n# the activated property.\nactivated = database.activated\n```\n```python\n\n# the public key activated property.\npublic_key_activated = database.public_key_activated\n```\n```python\n\n# the private key activated property.\nprivate_key_activated = database.private_key_activated\n```\n\n## File:\nThe file object class.\n``` python \n\n# initialize the dev0s.encryption.Database.File object class.\nfile = dev0s.encryption.Database.File(\n    # the path.\n    path=None,\n    # the default data, specify to call file.check() automatically.\n    default=None,\n    # the aes object.\n    aes=None, )\n\n```\n\n#### Functions:\n\n##### load:\n``` python\n\n# call file.load.\nresponse = file.load()\n\n```\n##### save:\n``` python\n\n# call file.save.\nresponse = file.save()\n\n```\n\n## Array:\nThe array object class.\n``` python \n\n# initialize the dev0s.encryption.Database.Array object class.\narray = dev0s.encryption.Database.Array(\n    # the path.\n    path=None,\n    # the default data, specify to call array.check() automatically.\n    default=None,\n    # the aes object.\n    aes=None, )\n\n```\n\n#### Functions:\n\n##### load:\n``` python\n\n# call array.load.\nresponse = array.load()\n\n```\n##### save:\n``` python\n\n# call array.save.\nresponse = array.save()\n\n```\n\n## Dictionary:\nThe dictionary object class.\n``` python \n\n# initialize the dev0s.encryption.Database.Dictionary object class.\ndictionary = dev0s.encryption.Database.Dictionary(\n    # the path.\n    path=None,\n    # the default data, specify to call dictionary.check() automatically.\n    default=None,\n    # the aes object.\n    aes=None, )\n\n```\n\n#### Functions:\n\n##### load:\n``` python\n\n# call dictionary.load.\nresponse = dictionary.load()\n\n```\n##### save:\n``` python\n\n# call dictionary.save.\nresponse = dictionary.save()\n\n```\n\n## RSA:\nThe rsa object class.\n``` python \n\n# initialize the dev0s.encryption.RSA object class.\nrsa = dev0s.encryption.RSA(\n    # option 1:\n    #     the key directory.\n    directory=None,\n    # option 2:\n    public_key=None,\n    private_key=None,\n    memory=False, # enable memory when the keys are not saved.\n    # the key's passphrase (Leave None for no passphrase).\n    passphrase=None, )\n\n```\n\n#### Functions:\n\n##### generate_keys:\n``` python\n\n# call rsa.generate_keys.\nresponse = rsa.generate_keys(log_level=0)\n\n```\n##### load_keys:\n``` python\n\n# call rsa.load_keys.\nresponse = rsa.load_keys()\n\n```\n##### load_public_key:\n``` python\n\n# call rsa.load_public_key.\nresponse = rsa.load_public_key()\n\n```\n##### load_private_key:\n``` python\n\n# call rsa.load_private_key.\nresponse = rsa.load_private_key()\n\n```\n##### edit_passphrase:\n``` python\n\n# call rsa.edit_passphrase.\nresponse = rsa.edit_passphrase(passphrase=None)\n\n```\n##### encrypt_string:\n``` python\n\n# call rsa.encrypt_string.\nresponse = rsa.encrypt_string(string, layers=1, decode=True)\n\n```\n##### encrypt_file:\n``` python\n\n# call rsa.encrypt_file.\nresponse = rsa.encrypt_file(path, layers=1)\n\n```\n##### encrypt_directory:\n``` python\n\n# call rsa.encrypt_directory.\nresponse = rsa.encrypt_directory(path, recursive=False, layers=1)\n\n```\n##### decrypt_string:\n``` python\n\n# call rsa.decrypt_string.\nresponse = rsa.decrypt_string(string, layers=1, decode=True)\n\n```\n##### decrypt_file:\n``` python\n\n# call rsa.decrypt_file.\nresponse = rsa.decrypt_file(path, layers=1)\n\n```\n##### decrypt_directory:\n``` python\n\n# call rsa.decrypt_directory.\nresponse = rsa.decrypt_directory(path, recursive=False, layers=1)\n\n```\n\n#### Properties:\n```python\n\n# the generated property.\ngenerated = rsa.generated\n```\n```python\n\n# the activated property.\nactivated = rsa.activated\n```\n```python\n\n# the private key activated property.\nprivate_key_activated = rsa.private_key_activated\n```\n```python\n\n# the public key activated property.\npublic_key_activated = rsa.public_key_activated\n```\n\n## Agent:\nThe agent object class.\n``` python \n\n# initialize the dev0s.encryption.Agent object class.\nagent = dev0s.encryption.Agent(\n    # the encryption \u0026 webserver's id (str).\n    id=\"dev0s-agent\",\n    # the path to the encrypted database (str, String, FilePath).\n    database=None,\n    # the webserver's host (str).\n    host=\"127.0.0.1\",\n    # the webserver's port (int).\n    port=56000,\n    # the path to the private key / the raw private key (str).\n    private_key=None,\n    # the path to the public key / the raw public key (str).\n    public_key=None,\n    # the passphrase (optional to prompt) (str).\n    passphrase=None,\n    # the encryption key in memory only (enable when you passed the private_key \u0026 public_key in raw format and the file path) (bool).\n    memory=False,\n    # the interactive mode (prompt for password) (bool).\n    interactive=True,\n    # the object traceback (str).\n    traceback=\"dev0s.encryption.Agent\", )\n\n```\n\n#### Functions:\n\n##### generate:\n``` python\n\n# call agent.generate.\nresponse = agent.generate(\n    # the passphrase (optional to prompt) (str).\n    passphrase=None,\n    # the verify passphrase (optional).\n    verify_passphrase=None,\n    # interactive (optional).\n    interactive=None )\n\n```\n##### activate:\n``` python\n\n# call agent.activate.\nresponse = agent.activate(\n    # the key's passphrase (optional to retrieve from webserver) (str).\n    passphrase=None,\n    # interactive (optional)\n    interactive=None, )\n\n```\n##### encrypt:\n``` python\n\n# call agent.encrypt.\n_ = agent.encrypt(string, decode=False)\n\n```\n##### decrypt:\n``` python\n\n# call agent.decrypt.\n_ = agent.decrypt(string, decode=False)\n\n```\n\n#### Properties:\n```python\n\n# the activated property.\nactivated = agent.activated\n```\n```python\n\n# the public key activated property.\npublic_key_activated = agent.public_key_activated\n```\n```python\n\n# the private key activated property.\nprivate_key_activated = agent.private_key_activated\n```\n```python\n\n# the generated property.\ngenerated = agent.generated\n```\n\n#### unpack:\nThe dev0s.classes.encryption.aes.unpack function.\n``` python\n\n# call dev0s.classes.encryption.aes.unpack.\n_ = dev0s.classes.encryption.aes.unpack(content)\n\n```\n#### argument_present:\nThe dev0s.classes.cli.argument_present function.\n``` python\n\n# call dev0s.classes.cli.argument_present.\n_ = dev0s.classes.cli.argument_present(arguments, default=False, count=1)\n\n```\n#### arguments_present:\nThe dev0s.classes.cli.arguments_present function.\n``` python\n\n# call dev0s.classes.cli.arguments_present.\n_ = dev0s.classes.cli.arguments_present(arguments, default=False, count=1)\n\n```\n#### get_argument:\nThe dev0s.classes.cli.get_argument function.\n``` python\n\n# call dev0s.classes.cli.get_argument.\n_ = dev0s.classes.cli.get_argument(argument, required=True, index=1, count=1, default=None, )\n\n```\n#### check_user:\nThe dev0s.classes.system.system.check_user function.\n``` python\n\n# call dev0s.classes.system.system.check_user.\nresponse = dev0s.classes.system.system.check_user(id, create=False)\n\n```\n#### check_group:\nThe dev0s.classes.system.system.check_group function.\n``` python\n\n# call dev0s.classes.system.system.check_group.\nresponse = dev0s.classes.system.system.check_group(id, users=[], create=False, overwrite=False)\n\n```\n#### check_os:\nThe dev0s.classes.system.disks.check_os function.\n``` python\n\n# call dev0s.classes.system.disks.check_os.\nresponse = dev0s.classes.system.disks.check_os(supported=[\"linux\"], error=False)\n\n```\n#### coming_soon:\nThe dev0s.classes.system.disks.coming_soon function.\n``` python\n\n# call dev0s.classes.system.disks.coming_soon.\n_ = dev0s.classes.system.disks.coming_soon()\n\n```\n#### log:\nThe dev0s.classes.console.log function.\n``` python\n\n# call dev0s.classes.console.log.\n_ = dev0s.classes.console.log(msg, back=0)\n\n```\n## FireWall:\nThe fire_wall object class.\n``` python \n\n# import the dev0s.network.firewall object class.\nimport dev0s\n\n```\n\n#### Functions:\n\n##### enable:\n``` python\n\n# call fire_wall.enable.\nresponse = fire_wall.enable()\n\n```\n##### disable:\n``` python\n\n# call fire_wall.disable.\nresponse = fire_wall.disable()\n\n```\n##### allow:\n``` python\n\n# call fire_wall.allow.\nresponse = fire_wall.allow(port)\n\n```\n##### deny:\n``` python\n\n# call fire_wall.deny.\nresponse = fire_wall.deny(port)\n\n```\n##### allow_all:\n``` python\n\n# call fire_wall.allow_all.\nresponse = fire_wall.allow_all()\n\n```\n##### deny_all:\n``` python\n\n# call fire_wall.deny_all.\nresponse = fire_wall.deny_all()\n\n```\n##### set_default:\n``` python\n\n# call fire_wall.set_default.\nresponse = fire_wall.set_default(deny=True)\n\n```\n##### info:\n``` python\n\n# call fire_wall.info.\nresponse = fire_wall.info()\n\n```\n\n## Network:\nThe network object class.\n``` python \n\n# import the dev0s.network object class.\nimport dev0s\n\n```\n\n#### Functions:\n\n##### info:\n``` python\n\n# call network.info.\nresponse = network.info()\n\n```\n##### convert_dns:\n``` python\n\n# call network.convert_dns.\nresponse = network.convert_dns(dns, timeout=1)\n\n```\n##### ping:\n``` python\n\n# call network.ping.\nresponse = network.ping(ip, timeout=1)\n\n```\n##### port_in_use:\n``` python\n\n# call network.port_in_use.\n_ = network.port_in_use(port, host=\"127.0.0.1\")\n\n```\n##### free_port:\n``` python\n\n# call network.free_port.\nresponse = network.free_port(start=6080)\n\n```\n\n## Requests:\nThe requests object class.\n``` python \n\n# import the dev0s.requests object class.\nimport dev0s\n\n```\n\n#### Functions:\n\n##### encode:\n``` python\n\n# call requests.encode.\n_ = requests.encode(data={})\n\n```\n##### quote:\n``` python\n\n# call requests.quote.\n_ = requests.quote(data={})\n\n```\n##### unquote:\n``` python\n\n# call requests.unquote.\n_ = requests.unquote(encoded, depth=30)\n\n```\n##### serialize:\n``` python\n\n# call requests.serialize.\n_ = requests.serialize(data={})\n\n```\n##### get:\n``` python\n\n# call requests.get.\nresponse = requests.get(\n    # the url (str) (#1).\n    url=None,\n    # the sended post data (dict) (#2).\n    data={},\n    # serialize output to dictionary.\n    serialize=False, )\n\n```\n\n## RestAPI:\nThe restapi object class.\n``` python \n\n# initialize the dev0s.requests.RestAPI object class.\nrestapi = dev0s.requests.RestAPI(\n    # the root url (optional).\n    url=None,\n    # the default data send with every request (will be appended to local data).\n    data={\n        \"api_key\":None,\n    }, )\n\n```\n\n#### Functions:\n\n##### get:\n``` python\n\n# call restapi.get.\n_ = restapi.get(url=\"/\", data={})\n\n```\n\n## Response:\nThe response object class.\n``` python \n\n# import the dev0s.response object class.\nimport dev0s\n\n```\n\n#### Functions:\n\n##### success:\n``` python\n\n# call response.success.\nresponse = response.success(\n    # the message (must be param #1).\n    message,\n    # additional returnable functions (must be param #2).\n    variables={},\n    # log log level of the message (int).\n    log_level=None,\n    # the required log level for when printed to console (leave None to use response.log_level).\n    required_log_level=None,\n    # save the error to the logs file.\n    save=False,\n    # return as a django Jsonresponse.\n    django=False, )\n\n```\n##### error:\n``` python\n\n# call response.error.\nresponse = response.error(\n    # the error message.\n    error=\"\",\n    # log log level of the message (int).\n    log_level=None,\n    # the required log level for when printed to console (leave None to use response.log_level).\n    required_log_level=None,\n    # save the error to the erros file.\n    save=False,\n    # return as a django Jsonresponse.\n    django=False,\n    # raise error for developer traceback.\n    traceback=ERROR_TRACEBACK, )\n\n```\n##### log:\n``` python\n\n# call response.log.\n_ = response.log(\n    # option 1:\n    # the message (#1 param).\n    message=None,\n    # option 2:\n    # the error.\n    error=None,\n    # option 3:\n    # the response dict (leave message None to use).\n    response={},\n    # print the response as json.\n    json=False,\n    # optionals:\n    # the active log level.\n    log_level=0,\n    # the required log level for when printed to console (leave None to use response.log_level).\n    required_log_level=None,\n    # save to log file.\n    save=False,\n    # save errors always (for options 2 \u0026 3 only).\n    save_errors=None,\n    # the log mode (leave None for default).\n    mode=None, )\n\n```\n##### load_logs:\n``` python\n\n# call response.load_logs.\n_ = response.load_logs(format=\"webserver\", options=[\"webserver\", \"cli\", \"array\", \"string\"])\n\n```\n##### reset_logs:\n``` python\n\n# call response.reset_logs.\n_ = response.reset_logs(format=\"webserver\", options=[\"webserver\", \"cli\", \"array\", \"string\"])\n\n```\n##### serialize:\n``` python\n\n# call response.serialize.\n_ = response.serialize(\n    # the variable to serialize.\n    variable={},\n    # serialize to json format.\n    json=False,\n    # serialize all unknown objects to str.\n    safe=False, )\n\n```\n##### response:\n``` python\n\n# call response.response.\n_ = response.response(\n    # the blank response (dict, str, generator) (#1).\n    response={\n        \"success\":False,\n        \"message\":None,\n        \"error\":None,\n    }, )\n\n```\n##### log_to_file:\n``` python\n\n# call response.log_to_file.\nresponse = response.log_to_file(message, raw=False)\n\n```\n##### quote:\n``` python\n\n# call response.quote.\n_ = response.quote(dictionary)\n\n```\n##### unquote:\n``` python\n\n# call response.unquote.\n_ = response.unquote(encoded)\n\n```\n\n## Parameters:\nThe parameters object class.\n``` python \n\n# import the dev0s.response.parameters object class.\nimport dev0s\n\n```\n\n#### Functions:\n\n##### get:\n``` python\n\n# call parameters.get.\n_ = parameters.get(\n    # the django request (1).\n    request=None,\n    # the identifiers (#2).\n    #    str instance: return the parameters value.\n    #    list instance: return a parameters object \u0026 return an error response when a parameter is undefined.\n    #    dict instance: return a parameters object \u0026 return the parameter's value from the dict as a default when undefined.\n    parameters=[],\n    # traceback id.\n    traceback=None, )\n\n```\n##### check:\n``` python\n\n# call parameters.check.\nresponse = parameters.check(\n    # the parameters (dict) (#1).\n    parameters={\"parameter\":None},\n    # the recognizer value for when the parameters are supposed to be empty.\n    default=None,\n    # the traceback id.\n    traceback=None, )\n\n```\n\n## ResponseObject:\nThe response_object object class.\n``` python \n\n# initialize the ResponseObject object class.\nresponse_object = ResponseObject(\n    #\n    # Should be initialized with response.success or response.error.\n    #\n    # the response attributes (dict or dict in str format).\n    attributes={\n        \"success\":False,\n        \"message\":None,\n        \"error\":None,\n    }, )\n\n```\n\n#### Functions:\n\n##### clean:\n``` python\n\n# call response_object.clean.\n_ = response_object.clean(\n    # the clean options, select * for all, options: [traceback].\n    options=[\"*\"],\n    # serialize to ResponseObject (with serialize False the ResponseObject's values are not updated).\n    serialize=True, )\n\n```\n##### assign:\n``` python\n\n# call response_object.assign.\n_ = response_object.assign(dictionary)\n\n```\n##### crash:\n``` python\n\n# call response_object.crash.\n_ = response_object.crash(error=\"ValueError\", traceback=True, json=False, error_only=False)\n\n```\n##### unpack:\n``` python\n\n# call response_object.unpack.\n_ = response_object.unpack(\n    # the key / keys / defaults parameter (#1).\n    # str instance:\n    #   unpack the str key\n    # list instance:\n    #   unpack all keys in the list.\n    # dict instance:\n    #   unpack all keys from the dict \u0026 when not present return the key's value as default.\n    keys, )\n\n```\n##### remove:\n``` python\n\n# call response_object.remove.\n_ = response_object.remove(keys=[], values=[], save=False)\n\n```\n##### iterate:\n``` python\n\n# call response_object.iterate.\n_ = response_object.iterate(sorted=False, reversed=False)\n\n```\n##### items:\n``` python\n\n# call response_object.items.\n_ = response_object.items(sorted=False, reversed=False, dictionary=None)\n\n```\n##### keys:\n``` python\n\n# call response_object.keys.\n_ = response_object.keys(sorted=False, reversed=False)\n\n```\n##### values:\n``` python\n\n# call response_object.values.\n_ = response_object.values(sorted=False, reversed=False, dictionary=None)\n\n```\n##### reversed:\n``` python\n\n# call response_object.reversed.\n_ = response_object.reversed(dictionary=None)\n\n```\n##### sort:\n``` python\n\n# call response_object.sort.\n_ = response_object.sort(alphabetical=True, ascending=False, reversed=False, dictionary=None)\n\n```\n##### dict:\n``` python\n\n# call response_object.dict.\n_ = response_object.dict(sorted=False, reversed=False, json=False, safe=False)\n\n```\n##### json:\n``` python\n\n# call response_object.json.\n_ = response_object.json(sorted=False, reversed=False, indent=4, safe=True, dictionary=None, )\n\n```\n##### serialize:\n``` python\n\n# call response_object.serialize.\nresponse = response_object.serialize(sorted=False, reversed=False, json=False, safe=False, dictionary=None)\n\n```\n##### instance:\n``` python\n\n# call response_object.instance.\n_ = response_object.instance()\n\n```\n##### raw:\n`","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvandenberghinc%2Fdev0s","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvandenberghinc%2Fdev0s","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvandenberghinc%2Fdev0s/lists"}