Metadata-Version: 2.2
Name: thors_hammer
Version: 2.0.0
Summary: A simple command line password generator.
Home-page: https://github.com/uwungu01-rep/passgen-python.edition
Author: Zizel
Author-email: danbua999@gmail.com
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: ziz-utils
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: home-page
Dynamic: requires-dist
Dynamic: summary

# Thor's Hammer - Python Edition
(The name sounds way cooler in my head I swear)
<!-- 
Fun facts:
1. The name Thor's Hammer refer to the weapon of the Norse Mythology's God, Thor, which is named Mjolnir, hence why the command to run this program is "mjolnir".
2. It's also a reference to Resident Evil 7's Not a Hero DLC, where Chris Redfield shotgun is called "Thor's Hammer".
-->
A simple command line password generator. And yes, there WILL be more of this from other languages.

## Functionalities
Generate passwords with configurable settings for the generator, these include:
1. Configure the password's length
2. Toggle whether or not you want to generate passwords with uppercase letters.
3. Toggle whether or not you want to generate passwords with numbers.
4. Toggle whether or not you want to generate passwords with special characters.

## Installation
<ol type="1">
  <li>
    Install Python 3.x from <a href="https://www.python.org/downloads/">here</a>. (Ignore if you already have Python 3.x installed)
  </li>
  <li>
    Open terminal, run:
    
```
pip install thors_hammer
```
  </li>
</ol>

## Usage
<ol type="1">
  <li>
    Open terminal, run:

```
mjolnir
```
  </li>
  <li>
    Alternatively, in a Python file (*.py), you can do:
    
```py
from thors_hammer import main
main()
```
  </li>
</ol>

## Requirement(s)
1.  Python 3.x

## Note(s)
1. Deleting the config folder/file could cause everything to revert back to the default setting the next time you boot up the progam.

## License
This project is licensed under the GNU General Public License 3.0, check [LICENSE](LICENSE) for more details.
