# Offuscat Documentation
**Offuscat** is a Python module for obfuscating and decoding Python code using base64 encoding and character replacement.
## Installation
You can install **Offuscat** using pip:
```shell
pip install Offuscats.py
```
## Usage
To use Offuscat.py, you can follow the example below:
```py
from Offuscat.Offuscats import Offuscats
# Create an instance of Offuscat with your Python code
my_code = "print('Hello, World!')"
offuscat_instance = Offuscats(script=my_code)
# Obfuscate the code
obfuscated_code = offuscat_instance.obfuscate()
# Make the code illegible
illegible_code = offuscat_instance.make_ilisible()
# Decode and execute the obfuscated code
offuscat_instance.decode()
```
Class: Offuscats
__init__(self, script=None, file=None)
Initialize an instance of Offuscat.
script (str, optional): The Python code to be obfuscated or decoded.
file (str, optional): The file to be obfuscated.
obfuscate(self)
Obfuscates the code using base64 encoding.
Returns:
str: The obfuscated code.
make_ilisible(self)
Replaces each character in the obfuscated code with a string of special characters.
Returns:
str: The illegible code.
decode(self)
Decodes the obfuscated code using base64 decoding and executes it.
obfuscate_file(self)
Obfuscates a Python file using base64 encoding and character replacement.
Parameters:
file (str): The file to be obfuscated.
Example
You can obfuscate a Python file with the following code:
```py
from Offuscat.Offuscats import Offuscats
# Create an instance of Offuscat with a file path
file_path = "example.py"
offuscat_instance = Offuscats(file=file_path)
# Obfuscate the file
offuscat_instance.obfuscate_file()
```
This is a basic example of how to use the Offuscat module. You can customize it and provide more detailed explanations as needed.
Raw data
{
"_id": null,
"home_page": "https://github.com/TryWarzFiles/Offuscat",
"name": "Offuscats",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "obfuscation,obfuscate,obfuscator,obfuscating,obfuscated,obfuscates,obfuscators",
"author": "TryWarz",
"author_email": "trywarz@trywarz.online",
"download_url": "https://files.pythonhosted.org/packages/b5/35/e72ba4007dfbf45537f01ccdc7ca329f676d740f7d00110b775a202dae75/Offuscats-1.0.1.tar.gz",
"platform": null,
"description": "# Offuscat Documentation\r\n\r\n**Offuscat** is a Python module for obfuscating and decoding Python code using base64 encoding and character replacement.\r\n\r\n## Installation\r\n\r\nYou can install **Offuscat** using pip:\r\n\r\n```shell\r\npip install Offuscats.py\r\n```\r\n\r\n## Usage\r\nTo use Offuscat.py, you can follow the example below:\r\n```py\r\nfrom Offuscat.Offuscats import Offuscats\r\n\r\n# Create an instance of Offuscat with your Python code\r\n\r\nmy_code = \"print('Hello, World!')\"\r\noffuscat_instance = Offuscats(script=my_code)\r\n\r\n# Obfuscate the code\r\n\r\nobfuscated_code = offuscat_instance.obfuscate()\r\n\r\n# Make the code illegible\r\n\r\nillegible_code = offuscat_instance.make_ilisible()\r\n\r\n# Decode and execute the obfuscated code\r\noffuscat_instance.decode()\r\n```\r\nClass: Offuscats\r\n__init__(self, script=None, file=None)\r\nInitialize an instance of Offuscat.\r\n\r\nscript (str, optional): The Python code to be obfuscated or decoded.\r\nfile (str, optional): The file to be obfuscated.\r\nobfuscate(self)\r\nObfuscates the code using base64 encoding.\r\n\r\nReturns:\r\n\r\nstr: The obfuscated code.\r\nmake_ilisible(self)\r\nReplaces each character in the obfuscated code with a string of special characters.\r\n\r\nReturns:\r\n\r\nstr: The illegible code.\r\ndecode(self)\r\nDecodes the obfuscated code using base64 decoding and executes it.\r\n\r\nobfuscate_file(self)\r\nObfuscates a Python file using base64 encoding and character replacement.\r\n\r\nParameters:\r\n\r\nfile (str): The file to be obfuscated.\r\nExample\r\nYou can obfuscate a Python file with the following code:\r\n\r\n```py\r\nfrom Offuscat.Offuscats import Offuscats\r\n\r\n# Create an instance of Offuscat with a file path\r\nfile_path = \"example.py\"\r\noffuscat_instance = Offuscats(file=file_path)\r\n\r\n# Obfuscate the file\r\noffuscat_instance.obfuscate_file()\r\n```\r\nThis is a basic example of how to use the Offuscat module. You can customize it and provide more detailed explanations as needed.\r\n\r\n\r\n",
"bugtrack_url": null,
"license": "apache-2.0",
"summary": "A Python obfuscator. Github official : https://github.com/TryWarzFiles/Offuscat",
"version": "1.0.1",
"project_urls": {
"Homepage": "https://github.com/TryWarzFiles/Offuscat"
},
"split_keywords": [
"obfuscation",
"obfuscate",
"obfuscator",
"obfuscating",
"obfuscated",
"obfuscates",
"obfuscators"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "adc805828c4d0aedbd9d74eb9269d27a085bb841cd61e6f0769e896fd606bfab",
"md5": "2f792ab0ca37024da35886b9ae9353ce",
"sha256": "95f984f17338b3384577c70d4ce42300f44aeef81129ccaf54a2518df15f9dac"
},
"downloads": -1,
"filename": "Offuscats-1.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "2f792ab0ca37024da35886b9ae9353ce",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 2740,
"upload_time": "2023-11-01T23:27:05",
"upload_time_iso_8601": "2023-11-01T23:27:05.864225Z",
"url": "https://files.pythonhosted.org/packages/ad/c8/05828c4d0aedbd9d74eb9269d27a085bb841cd61e6f0769e896fd606bfab/Offuscats-1.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "b535e72ba4007dfbf45537f01ccdc7ca329f676d740f7d00110b775a202dae75",
"md5": "084069704d2239008ef9c16eb11c7acd",
"sha256": "1cd80247709c33c9c84a9cbd00e29abfe48b25b5d0371dba920e7b8930631c55"
},
"downloads": -1,
"filename": "Offuscats-1.0.1.tar.gz",
"has_sig": false,
"md5_digest": "084069704d2239008ef9c16eb11c7acd",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 2410,
"upload_time": "2023-11-01T23:27:08",
"upload_time_iso_8601": "2023-11-01T23:27:08.197207Z",
"url": "https://files.pythonhosted.org/packages/b5/35/e72ba4007dfbf45537f01ccdc7ca329f676d740f7d00110b775a202dae75/Offuscats-1.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-11-01 23:27:08",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "TryWarzFiles",
"github_project": "Offuscat",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "offuscats"
}
JSON
