{
"info": {
"author": "AbleInc - Jaylen Douglas",
"author_email": "douglas.jaylen@gmail.com",
"bugtrack_url": null,
"classifiers": [
"License :: OSI Approved :: MIT License",
"Operating System :: OS Independent",
"Programming Language :: Python :: 3.5",
"Programming Language :: Python :: 3.6",
"Programming Language :: Python :: 3.7",
"Programming Language :: Python :: 3.8",
"Programming Language :: Python :: 3 :: Only"
],
"description": "# Polysecrets\n\nA completely randomized order of secrets; built with security in mind. Secrets can be automatically generated\non a time interval or manually generated. Polysecrets keeps the guessing away from the human in exchange for\na truly secret, randomized signing order. Instead of a hardcoded secret that can be stolen during a security\nbreach, Polysecrets, randomizes the provided string in a way that a secret produced at 8:00pm can be completely\ndifferent from a secret produced at 8:01pm, on the same server.\n\n# Requirements\n* Python 3.5+\n* Windows, OSX or Linux\n\n# Install\nLocally\n```bash\ngit clone https://github.com/ableinc/polysecrets.git\ncd polysecrets\n\npython3.6 -m pip install --upgrade .\n or \npip3.6 install --upgrade .\n```\nPyPi (Pip)\n```bash\npython3.6 -m pip install --upgrade polysecrets\n or\npip3.6 install --upgrade polysecrets\n```\n# How To Use\nPolysecrets can be used manually or automated. Automated use can be provided a time (in seconds) for\nhow often a new secret should be generated, the default time is set to 30 seconds.
\n\n** Run test.py to see a working example **
\n\nAutomated (this will add the secret to your environment)\n```python\nfrom os import environ\nfrom polysecrets import PolySecrets\n\nPolySecrets('rAnd0m_s3cr3t', 15).automated() # default time is set to 30 seconds\nprint(environ['secret']) # confirm secret is available\n```\n\nManual: \n```python\nfrom polysecrets import PolySecrets\n\nsecret = PolySecrets('rAnd0m_s3cr3t').manual()\nprint(secret) # confirm secret is available\n```\n\nRefer to examples folder for all use cases.\n\n# Options\nYou can do the following with Polysecrets:\n* Manually or Automatically generate new secrets\n* Change time interval for new secret generation (for Automated feature)\n* Change the length of the final Polysecrets secret (refer to Notes at end of README)\n* Choose whether to generate secrets with just UUIDs, Alphanumeric characters or both\n* Choose whether to change the case of various characters in Polysecrets secret\n\nThe CLI (below) has full details of each option (except automated option)\n\n# CLI\nYou can use Polysecrets as a command line tool. CLI does not provided automated feature.
\n```bash\npolysecrets -s rAnd0m_s3cr3t\n```\n\n```bash \nUsage: polysecrets [OPTIONS]\n\nOptions:\n -s, --secret TEXT The secret string [required]\n -l, --length INTEGER Length of the secret. Secret has a minimum length of\n 10\n -u, --uuid INTEGER Whether to use UUIDs or Alphanumeric characters for\n secret generation\n -m, --mixcase BOOLEAN Decide whether or not to mix the case of\n alphacharacters in secret string\n --version Show the version and exit.\n --help Show this message and exit.\n\n```\n\n# Benefits\n* JSON Web Tokens\n* Certificate Signing\n* Hashing\n* Various scenarios of Cryptography\n\n# What's Next