Skip to content

Commit

Permalink
Refactored README and added license
Browse files Browse the repository at this point in the history
  • Loading branch information
Blank-c authored Mar 28, 2024
1 parent b787af0 commit c710b26
Show file tree
Hide file tree
Showing 2 changed files with 65 additions and 3 deletions.
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2024 Blank-c

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
47 changes: 44 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,48 @@
# BlankOBF (Version 2)
**Obfuscates python program to make it harder to read.**

Usage:
```batch
**BlankOBF** is a tool designed to obfuscate Python programs, making them more challenging to understand for casual user. Please note that while obfuscation can deter casual users, determined individuals can still reverse engineer the code with effort. It's essential to understand that obfuscation does not provide security but rather adds a layer of complexity.

## Features
- **Python Obfuscation:** BlankOBF utilizes techniques to obscure Python code, making it less readable to human eyes.
- **Customization:** Offers various options to customize the obfuscation process, such as recursive obfuscation and inclusion of imports.
- **Command-line Interface:** Convenient command-line interface for easy integration into your development workflow.

## Usage
### From command line:
```bash
python BlankOBFv2.py [-h] --input PATH [--output PATH] [--recursive N] [--include_imports]
```
- **-h, --help:** Show the help message and exit.
- **--input PATH:** Specify the input file or directory to be obfuscated.
- **--output PATH:** Optional flag to specify the output filename for the obfuscated code.
- **--recursive N:** Optional flag to specify the depth of recursive obfuscation (default is 1).
- **--include_imports:** Optional flag to include imports in the obfuscated file.

### From code:
```python
from BlankOBFv2 import BlankOBFv2

# Your Python code to obfuscate
code_to_obfuscate = """
def hello_world():
print("Hello, world!")
hello_world()
"""

# Instantiate BlankOBFv2 with your code
obfuscator = BlankOBFv2(code=code_to_obfuscate, include_imports=False, recursion=1)

# Obfuscate the code
obfuscated_code = obfuscator.obfuscate()

# Print or use the obfuscated code as needed
print(obfuscated_code)

```

## Note
Keep in mind that while obfuscation can add a layer of complexity to your code, it's not a substitute for proper security measures. Always implement robust security practices to protect your intellectual property and sensitive data.

## License
This project is licensed under the MIT License - see the LICENSE file for details.

0 comments on commit c710b26

Please sign in to comment.