# WordListGenerator
## Description
This package build a custom WordList (BruteForce).
With this WordListGenerator you can build your custom wordlist with:
- wordlist in pattern (file)
- some specific words/strings (command line)
- custom characters enumerator
- maximum length/time
## Requirements
This package require :
- python3
- python3 Standard Library
## Installation
```bash
pip install WordListGenerator
```
## Usages
### Command line:
```bash
WordListGenerator -p "abc%(digits)"
python3 -m WordListGenerator --pattern "abc%(ascii_lowercase)"
```
### Python script
```python
from WordListGenerator import WordList
wordlist = WordList(
{
"%(abc)": PatternEnumerator("abc", "[a-c]", False, None),
"%(file)": PatternEnumerator("file", None, True, "test.txt"),
},
filename="abc.txt",
delimiter="\n",
max_words=5,
max_time=0.003,
encoding="utf-8",
)
wordlist.run("abc%(abc)%(file)%(digits)")
```
## Command line examples
```bash
WordListGenerator -p "abc%(digits)" # Default digits enumerator
WordListGenerator -p "abc%(ascii_lowercase)" # Default letters (lower) enumerator
WordListGenerator -p "abc%(ascii_uppercase)" # Default letters (upper) enumerator
WordListGenerator -p "abc%(ascii_visible)" # Default ascii enumerator
WordListGenerator -p "abc%(punctuation)" # Default ascii punctuation enumerator
WordListGenerator -e "a=abc" -p "abc%(a)" # Custom named enumerator (enumerate on "a", "b" and "c") (name: "a")
WordListGenerator -e "enumABC=abc" "enum123=123" -p "abc%(enumABC)%(enum123)" # Multiple named enumerators
WordListGenerator -e "abc" "123" -p "abc%(abc)%(123)" # Multiple enumerator (not named)
WordListGenerator -e "enumABC=[a-c]" "enum123=[1-3]" -p "abc%(enumABC)%(enum123)" # Using character pattern for enumerator ("[1-3]" = "1", "2" and "3"; "[a-c]" = "a", "b" and "c")
WordListGenerator -e "enumABC&CBA=(ABC|CBA)" "enum123=[1-3]" -p "abc%(enumABC&CBA)%(enum123)" # Using word pattern for enumerator ("(ABC|CBA)" = "ABC" and "CBA")
WordListGenerator -w "a=test.txt" -p "abc%(a)" # Using named wordlist
WordListGenerator -e "abc" "123" -m 5 -p "abc%(abc)%(123)" # Using max length
WordListGenerator -e "abc" "123" -t 0.0003 -p "abc%(abc)%(123)" # Using max time
WordListGenerator -e "abc" "123" -f "abc.txt" -p "abc%(abc)%(123)" # Save in file "abc.txt"
WordListGenerator -e "abc" "123" -E "ascii" -p "abc%(abc)%(123)" # Use ascii encoding
WordListGenerator -e "abc" "123" -d "," -p "abc%(abc)%(123)" # Use custom delimiter
WordListGenerator -e "abc" "123" -p "abc%(abc){3}%(123)" # Repeat a pattern
```
## Links
- [Github Page](https://github.com/mauricelambert/WordListGenerator/)
- [Documentation](https://mauricelambert.github.io/info/python/security/WordListGenerator.html)
- [Python executable](https://mauricelambert.github.io/info/python/security/WordListGenerator.pyz)
- [Pypi package](https://pypi.org/project/WordListGenerator/)
## Licence
Licensed under the [GPL, version 3](https://www.gnu.org/licenses/).
Raw data
{
"_id": null,
"home_page": "https://github.com/mauricelambert/WordListGenerator",
"name": "WordListGenerator",
"maintainer": "Maurice Lambert",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "mauricelambert434@gmail.com",
"keywords": "",
"author": "Maurice Lambert",
"author_email": "mauricelambert434@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/92/26/c0434bc8ac03b4023d1ce6f4b74387417dcd4d76b6363a68fd2826f529a0/WordListGenerator-0.1.0.tar.gz",
"platform": null,
"description": "![WordListGenerator logo](https://mauricelambert.github.io/info/python/security/WordListGenerator_small.png \"WordListGenerator logo\")\n\n# WordListGenerator\n\n## Description\n\nThis package build a custom WordList (BruteForce).\n\nWith this WordListGenerator you can build your custom wordlist with:\n - wordlist in pattern (file)\n - some specific words/strings (command line)\n - custom characters enumerator\n - maximum length/time\n\n## Requirements\n\nThis package require :\n - python3\n - python3 Standard Library\n\n## Installation\n\n```bash\npip install WordListGenerator\n```\n\n## Usages\n\n### Command line:\n\n```bash\nWordListGenerator -p \"abc%(digits)\"\npython3 -m WordListGenerator --pattern \"abc%(ascii_lowercase)\"\n```\n\n### Python script\n\n```python\nfrom WordListGenerator import WordList\n\nwordlist = WordList(\n {\n \"%(abc)\": PatternEnumerator(\"abc\", \"[a-c]\", False, None),\n \"%(file)\": PatternEnumerator(\"file\", None, True, \"test.txt\"),\n },\n filename=\"abc.txt\",\n delimiter=\"\\n\",\n max_words=5,\n max_time=0.003,\n encoding=\"utf-8\",\n)\nwordlist.run(\"abc%(abc)%(file)%(digits)\")\n```\n\n## Command line examples\n\n```bash\nWordListGenerator -p \"abc%(digits)\" # Default digits enumerator\nWordListGenerator -p \"abc%(ascii_lowercase)\" # Default letters (lower) enumerator\nWordListGenerator -p \"abc%(ascii_uppercase)\" # Default letters (upper) enumerator\nWordListGenerator -p \"abc%(ascii_visible)\" # Default ascii enumerator\nWordListGenerator -p \"abc%(punctuation)\" # Default ascii punctuation enumerator\nWordListGenerator -e \"a=abc\" -p \"abc%(a)\" # Custom named enumerator (enumerate on \"a\", \"b\" and \"c\") (name: \"a\")\nWordListGenerator -e \"enumABC=abc\" \"enum123=123\" -p \"abc%(enumABC)%(enum123)\" # Multiple named enumerators\nWordListGenerator -e \"abc\" \"123\" -p \"abc%(abc)%(123)\" # Multiple enumerator (not named)\nWordListGenerator -e \"enumABC=[a-c]\" \"enum123=[1-3]\" -p \"abc%(enumABC)%(enum123)\" # Using character pattern for enumerator (\"[1-3]\" = \"1\", \"2\" and \"3\"; \"[a-c]\" = \"a\", \"b\" and \"c\")\nWordListGenerator -e \"enumABC&CBA=(ABC|CBA)\" \"enum123=[1-3]\" -p \"abc%(enumABC&CBA)%(enum123)\" # Using word pattern for enumerator (\"(ABC|CBA)\" = \"ABC\" and \"CBA\")\nWordListGenerator -w \"a=test.txt\" -p \"abc%(a)\" # Using named wordlist\nWordListGenerator -e \"abc\" \"123\" -m 5 -p \"abc%(abc)%(123)\" # Using max length\nWordListGenerator -e \"abc\" \"123\" -t 0.0003 -p \"abc%(abc)%(123)\" # Using max time\nWordListGenerator -e \"abc\" \"123\" -f \"abc.txt\" -p \"abc%(abc)%(123)\" # Save in file \"abc.txt\"\nWordListGenerator -e \"abc\" \"123\" -E \"ascii\" -p \"abc%(abc)%(123)\" # Use ascii encoding\nWordListGenerator -e \"abc\" \"123\" -d \",\" -p \"abc%(abc)%(123)\" # Use custom delimiter\nWordListGenerator -e \"abc\" \"123\" -p \"abc%(abc){3}%(123)\" # Repeat a pattern\n```\n\n## Links\n\n - [Github Page](https://github.com/mauricelambert/WordListGenerator/)\n - [Documentation](https://mauricelambert.github.io/info/python/security/WordListGenerator.html)\n - [Python executable](https://mauricelambert.github.io/info/python/security/WordListGenerator.pyz)\n - [Pypi package](https://pypi.org/project/WordListGenerator/)\n\n## Licence\n\nLicensed under the [GPL, version 3](https://www.gnu.org/licenses/).",
"bugtrack_url": null,
"license": "",
"summary": "This package builds custom WordLists (for BruteForce).",
"version": "0.1.0",
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"md5": "bf5e079f861d1002b4f7055ef6e9c362",
"sha256": "0ab2fe81381143703eacce900b59affe44429a8bd682625798621d29296aed31"
},
"downloads": -1,
"filename": "WordListGenerator-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "bf5e079f861d1002b4f7055ef6e9c362",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 19214,
"upload_time": "2022-12-31T12:19:50",
"upload_time_iso_8601": "2022-12-31T12:19:50.206523Z",
"url": "https://files.pythonhosted.org/packages/92/26/c0434bc8ac03b4023d1ce6f4b74387417dcd4d76b6363a68fd2826f529a0/WordListGenerator-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2022-12-31 12:19:50",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "mauricelambert",
"github_project": "WordListGenerator",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "wordlistgenerator"
}
JSON
