{
    "info": {
        "author": "Chris Landa",
        "author_email": "stylesuxx@gmail.com",
        "bugtrack_url": null,
        "classifiers": [
            "Intended Audience :: Developers",
            "License :: OSI Approved :: MIT License",
            "Operating System :: OS Independent",
            "Programming Language :: Python",
            "Programming Language :: Python :: 2.7",
            "Topic :: Internet :: WWW/HTTP",
            "Topic :: Software Development :: Libraries :: Python Modules"
        ],
        "description": "# usernamegen\r\n> Genrate usernames with a Markov chain based on a wordlist\r\n\r\n[![Build Status](https://travis-ci.org/stylesuxx/usernamegen.svg?branch=master)](https://travis-ci.org/stylesuxx/usernamegen) [![Downloads](https://img.shields.io/pypi/dm/browserinfo.svg)](https://img.shields.io/pypi/dm/usernamegen.svg) [![Documentation Status](https://readthedocs.org/projects/usernamegen/badge/?version=latest)](http://sync.readthedocs.io/?badge=latest)\r\n\r\n## Wordlist\r\nIn order to get the most out of the word generation, make sure that you have one word per line, all lower case.\r\n\r\n## Installation\r\nSimply install via pip:\r\n\r\n    pip install usernamegen\r\n\r\n## Usage\r\n### Library\r\nYou can use the usernamegen directly in your python application.\r\n```bash\r\n>>> import usernamegen\r\n>>> words = ['foo', 'foobar', 'foobarbla', 'foobarblafasel']\r\n>>> formatters = [{'format': usernamegen.Formatter.Join, 'weight': 1}]\r\n>>> minLength = 8\r\n>>> size = 3\r\n>>> gen = usernamegen.Generator(words, size, minLength)\r\n>>> gen.setFormatters(formatters)\r\n>>> gen.getString()\r\n'foobarfoobarblafasel'\r\n```\r\n\r\nWhen multiple formmatters are used, the heigher the weight of a formatter the more likely it is, that it is used.\r\n\r\nThe following formatters are available:\r\n\r\n* Join\r\n* Underscore\r\n* Capitalize\r\n* CapitalizeExceptFirst\r\n* AppendNumber\r\n* CapitalizeAppendNumber\r\n\r\n### Scripts\r\nAfter installation there will be two script available:\r\n\r\n#### markov\r\n```bash\r\nusage: markov [-h] [-p PREV] [-n N] WORDLIST\r\n\r\nMarkov chain word generator. Generate new words based on aword list.\r\n\r\npositional arguments:\r\n  WORDLIST    Path to wordlist used for word generation\r\n\r\noptional arguments:\r\n  -h, --help  show this help message and exit\r\n  -p PREV     Number of previous letters to base chain on\r\n  -n N        Amount of new words to generate\r\n```\r\n\r\n#### username\r\n```bash\r\nusage: username [-h] [-p PREV] [-n N] [-m MIN] WORDLIST\r\n\r\nGenerate usernames based on a wordlist and a Markov chain.\r\n\r\npositional arguments:\r\n  WORDLIST    Path to wordlist used for word generation\r\n\r\noptional arguments:\r\n  -h, --help  show this help message and exit\r\n  -p PREV     Number of previous letters to base chain on\r\n  -n N        Amount of new words to generate\r\n  -m MIN      Minimum username length\r\n```\r\n\r\n## Running tests\r\n```bash\r\nnosetests --with-coverage --cover-package=usernamegen --with-json-extended\r\n```\r\n\r\n## Generating Documentation\r\n```bash\r\nsphinx-apidoc -o docs/source usernamegen -f\r\ncd docs && make html && cd ..\r\n```",
        "description_content_type": null,
        "docs_url": null,
        "download_url": "https://github.com/stylesuxx/usernamegen/tarball/0.1.1",
        "downloads": {
            "last_day": -1,
            "last_month": -1,
            "last_week": -1
        },
        "home_page": "https://github.com/stylesuxx/usernamegen/",
        "keywords": null,
        "license": "MIT",
        "maintainer": null,
        "maintainer_email": null,
        "name": "usernamegen",
        "package_url": "https://pypi.org/project/usernamegen/",
        "platform": "UNKNOWN",
        "project_url": "https://pypi.org/project/usernamegen/",
        "project_urls": {
            "Download": "https://github.com/stylesuxx/usernamegen/tarball/0.1.1",
            "Homepage": "https://github.com/stylesuxx/usernamegen/"
        },
        "release_url": "https://pypi.org/project/usernamegen/0.1.1/",
        "requires_dist": null,
        "requires_python": null,
        "summary": "Genrate usernames with a Markov chain based on a wordlist",
        "version": "0.1.1"
    },
    "last_serial": 2361921,
    "releases": {
        "0.1.1": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "d34ce2756362d11a759c693c3d4481fc",
                    "sha256": "a29154a0aebbe75a34fcf4a71658341367bc80a28c8ffacee08788bf7ba28251"
                },
                "downloads": -1,
                "filename": "usernamegen-0.1.1.tar.gz",
                "has_sig": false,
                "md5_digest": "d34ce2756362d11a759c693c3d4481fc",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 4681,
                "upload_time": "2016-09-25T00:20:34",
                "url": "https://files.pythonhosted.org/packages/b5/11/0c0cb4af6355794f5d6eaac5bac45e64b4cec5aeb3b231add57edced4d61/usernamegen-0.1.1.tar.gz"
            }
        ]
    },
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "d34ce2756362d11a759c693c3d4481fc",
                "sha256": "a29154a0aebbe75a34fcf4a71658341367bc80a28c8ffacee08788bf7ba28251"
            },
            "downloads": -1,
            "filename": "usernamegen-0.1.1.tar.gz",
            "has_sig": false,
            "md5_digest": "d34ce2756362d11a759c693c3d4481fc",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 4681,
            "upload_time": "2016-09-25T00:20:34",
            "url": "https://files.pythonhosted.org/packages/b5/11/0c0cb4af6355794f5d6eaac5bac45e64b4cec5aeb3b231add57edced4d61/usernamegen-0.1.1.tar.gz"
        }
    ]
}