Skip to content

Latest commit

 

History

History
102 lines (64 loc) · 2.36 KB

README.md

File metadata and controls

102 lines (64 loc) · 2.36 KB

pystrgpw

A simple package that generates random characters and can be used for strong passwords. 🎲 🔒

Requirements

  • Python >= 3.9.x

Install

To install the package, use the command below:

pip install pystrgpw

Usage

The basic usage of this package is explained below.

import pystrgpw

strgpw = pystrgpw.Generator()

# Set the character length output.
strgpw.length(25)

# Execute the generate process.
strgpw.generate()

# Get the generated output and print "0123456789abcdefghijklmn..."
print(strgpw.get())

To Contribute

Development

To prepare the dev environment, you need to run the command below in your virtualenv:

pip install -e .[dev]

Unit Testing

To run the test cases, use the command below:

pytest -s --verbose
TravisCI and Coveralls

When using a public repository on GitHub, the integration between TravisCI and Coveralls.io is pretty easy. To get started with coveralls-python, make sure to add your repo on the Coveralls.io. If you will be using coveralls-python on TravisCI, you’re done here.

Publishing the Package

To build the source code using bdist_wheel and sdist, use the command below:

python setup.py bdist_wheel sdist

To publish the source distribution on pypi.org (pip), run the command below:

  • Install the twine:

    pip install twine

  • Execute twine upload:

    twine upload dist/*

When using Docker as Local Environment Setup

Using Docker compose setup, we need to make sure to execute the commands below to avoid environment issues:

apk add --update --no-cache --virtual .tmp-build-deps gcc libc-dev linux-headers postgresql-dev libffi-dev

License

This package is open-sourced software licensed under the MIT license.