# SafePassGen
**SafePassGen** is a Python package for generating secure, customizable passwords with various constraints. It also includes functionality to check the strength and vulnerability of passwords, making it a comprehensive tool for managing password security.
## Features
- Generate passwords with specific requirements:
- Include or exclude numbers, lowercase, uppercase, and symbols.
- Option to start passwords with a letter.
- Avoid sequential characters.
- Avoid duplicate characters.
- Generate multiple passwords at once.
- Check password strength and vulnerability:
- Evaluate password length and character variety.
- Check against a list of common passwords and dictionary.
- Identify sequential or repeated characters.
## Installation
You can install **SafePassGen** via pip:
\`\`\`bash
pip install SafePassGen
\`\`\`
Or clone the repository and install manually:
\`\`\`bash
git clone https://github.com/diegoamengarelli/passgenesis.git
cd secure_password
pip install .
\`\`\`
## Usage
### Basic Usage
\`\`\`python
from securepassword import PasswordGenerator
# Create a password generator instance
generator = PasswordGenerator(length=12, include_numbers=True, include_lowercase=True,
include_uppercase=True, include_symbols=True,
no_duplicates=True, is_sequential=True, begin_with_letter=True, quantity=1)
# Generate a password
passwords = generator.generate_passwords()
print(passwords) # ['A1b2C3d4E5!']
\`\`\`
### Advanced Usage
\`\`\`python
# Generate multiple passwords with specific constraints
generator = PasswordGenerator(length=16, include_numbers=True, include_lowercase=True,
include_uppercase=True, include_symbols=True,
no_duplicates=False, begin_with_letter=False, quantity=5)
passwords = generator.generate_passwords()
print(passwords)
\`\`\`
### Checking Password Strength
\`\`\`python
from securepassword import PasswordStrengthChecker
checker = PasswordStrengthChecker(common_passwords=["password", "123456"])
password = "A1b2C3d4E5!"
result = checker.check_strength(password)
print(result)
Output:
{
"strength": "Strong",
"score": 5,
"suggestions": []
}
\`\`\`
## Configuration Options
### \`PasswordGenerator\`
- **length**: Length of the password(s) to be generated.
- **include_numbers**: Include numbers in the password.
- **include_lowercase**: Include lowercase characters in the password.
- **include_uppercase**: Include uppercase characters in the password.
- **include_symbols**: Include symbols in the password.
- **no_duplicates**: Ensure no duplicate characters within the password.
- **begin_with_letter**: Ensure the password starts with a letter.
- **only_numbers**: Generate passwords containing only numbers.
- **quantity**: Number of passwords to generate.
### \`PasswordStrengthChecker\`
- **common_passwords**: List of common passwords to check against. (Default: 10000 most common passwords)
- **min_length**: Minimum length required for a password to be considered strong. (Default: 10 chars)
- **dictionary_words**: List of dictionary words to check against for potential vulnerability. (Default: English dictionary)
## Testing
To run the tests, you can use:
\`\`\`bash
python -m unittest discover -s tests
\`\`\`
Make sure all tests pass before using the package in a production environment.
## Contributing
We welcome contributions to enhance the functionality and usability of **SafePassGen**. To contribute:
1. Fork the repository.
2. Create a new branch (\`git checkout -b feature-branch\`).
3. Make your changes.
4. Commit your changes (\`git commit -m 'Add new feature'\`).
5. Push to the branch (\`git push origin feature-branch\`).
6. Open a Pull Request.
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
Raw data
{
"_id": null,
"home_page": "https://github.com/diegoamengarelli/passgenesis",
"name": "SafePassGen",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": null,
"author": "Diego Mengarelli",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/61/d3/d8bb2014d58eef9112ea87bc99edb4155cbaeee3814c3042547d8da45da5/SafePassGen-1.0.6.tar.gz",
"platform": null,
"description": "\n# SafePassGen\n\n\n\n\n**SafePassGen** is a Python package for generating secure, customizable passwords with various constraints. It also includes functionality to check the strength and vulnerability of passwords, making it a comprehensive tool for managing password security.\n\n## Features\n\n- Generate passwords with specific requirements:\n - Include or exclude numbers, lowercase, uppercase, and symbols.\n - Option to start passwords with a letter.\n - Avoid sequential characters.\n - Avoid duplicate characters.\n - Generate multiple passwords at once.\n- Check password strength and vulnerability:\n - Evaluate password length and character variety.\n - Check against a list of common passwords and dictionary.\n - Identify sequential or repeated characters.\n\n## Installation\n\nYou can install **SafePassGen** via pip:\n\n\\`\\`\\`bash\npip install SafePassGen\n\\`\\`\\`\n\nOr clone the repository and install manually:\n\n\\`\\`\\`bash\ngit clone https://github.com/diegoamengarelli/passgenesis.git\ncd secure_password\npip install .\n\\`\\`\\`\n\n## Usage\n\n### Basic Usage\n\n\\`\\`\\`python\nfrom securepassword import PasswordGenerator\n\n# Create a password generator instance\ngenerator = PasswordGenerator(length=12, include_numbers=True, include_lowercase=True,\n include_uppercase=True, include_symbols=True,\n no_duplicates=True, is_sequential=True, begin_with_letter=True, quantity=1)\n\n# Generate a password\npasswords = generator.generate_passwords()\nprint(passwords) # ['A1b2C3d4E5!']\n\\`\\`\\`\n\n### Advanced Usage\n\n\\`\\`\\`python\n# Generate multiple passwords with specific constraints\ngenerator = PasswordGenerator(length=16, include_numbers=True, include_lowercase=True,\n include_uppercase=True, include_symbols=True, \n no_duplicates=False, begin_with_letter=False, quantity=5)\n\npasswords = generator.generate_passwords()\nprint(passwords) \n\\`\\`\\`\n\n### Checking Password Strength\n\n\\`\\`\\`python\nfrom securepassword import PasswordStrengthChecker\n\nchecker = PasswordStrengthChecker(common_passwords=[\"password\", \"123456\"])\npassword = \"A1b2C3d4E5!\"\nresult = checker.check_strength(password)\n\nprint(result)\nOutput:\n{\n \"strength\": \"Strong\",\n \"score\": 5,\n \"suggestions\": []\n}\n\\`\\`\\`\n\n## Configuration Options\n\n### \\`PasswordGenerator\\`\n\n- **length**: Length of the password(s) to be generated.\n- **include_numbers**: Include numbers in the password.\n- **include_lowercase**: Include lowercase characters in the password.\n- **include_uppercase**: Include uppercase characters in the password.\n- **include_symbols**: Include symbols in the password.\n- **no_duplicates**: Ensure no duplicate characters within the password.\n- **begin_with_letter**: Ensure the password starts with a letter.\n- **only_numbers**: Generate passwords containing only numbers.\n- **quantity**: Number of passwords to generate.\n\n### \\`PasswordStrengthChecker\\`\n\n- **common_passwords**: List of common passwords to check against. (Default: 10000 most common passwords)\n- **min_length**: Minimum length required for a password to be considered strong. (Default: 10 chars)\n- **dictionary_words**: List of dictionary words to check against for potential vulnerability. (Default: English dictionary)\n\n## Testing\n\nTo run the tests, you can use:\n\n\\`\\`\\`bash\npython -m unittest discover -s tests\n\\`\\`\\`\n\nMake sure all tests pass before using the package in a production environment.\n\n## Contributing\n\nWe welcome contributions to enhance the functionality and usability of **SafePassGen**. To contribute:\n\n1. Fork the repository.\n2. Create a new branch (\\`git checkout -b feature-branch\\`).\n3. Make your changes.\n4. Commit your changes (\\`git commit -m 'Add new feature'\\`).\n5. Push to the branch (\\`git push origin feature-branch\\`).\n6. Open a Pull Request.\n\n## License\n\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.\n\n",
"bugtrack_url": null,
"license": null,
"summary": "A package to generate secure passwords with customizable options and check vulnerability and strength",
"version": "1.0.6",
"project_urls": {
"Homepage": "https://github.com/diegoamengarelli/passgenesis"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "956ccba9046869d6e02aea6f2406ae4bb77439da8a92885b7d5e8ba8cab1092b",
"md5": "49a6d25457aae4af4cadf5bd345357cb",
"sha256": "64d2c0d994b945677da9b6212c2efad5b25e4378efcdea6eb3c0c343a390f1fd"
},
"downloads": -1,
"filename": "SafePassGen-1.0.6-py3-none-any.whl",
"has_sig": false,
"md5_digest": "49a6d25457aae4af4cadf5bd345357cb",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 8940,
"upload_time": "2024-08-11T13:56:36",
"upload_time_iso_8601": "2024-08-11T13:56:36.500331Z",
"url": "https://files.pythonhosted.org/packages/95/6c/cba9046869d6e02aea6f2406ae4bb77439da8a92885b7d5e8ba8cab1092b/SafePassGen-1.0.6-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "61d3d8bb2014d58eef9112ea87bc99edb4155cbaeee3814c3042547d8da45da5",
"md5": "c7ad23a19edbbc4f67db2e1c812e41ec",
"sha256": "4098411adbff70b421d4b395bd20dbb70e7723b7ff9ef4cb559363952cf889e4"
},
"downloads": -1,
"filename": "SafePassGen-1.0.6.tar.gz",
"has_sig": false,
"md5_digest": "c7ad23a19edbbc4f67db2e1c812e41ec",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 7107,
"upload_time": "2024-08-11T13:56:38",
"upload_time_iso_8601": "2024-08-11T13:56:38.408497Z",
"url": "https://files.pythonhosted.org/packages/61/d3/d8bb2014d58eef9112ea87bc99edb4155cbaeee3814c3042547d8da45da5/SafePassGen-1.0.6.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-11 13:56:38",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "diegoamengarelli",
"github_project": "passgenesis",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "safepassgen"
}
JSON
