NameITInteractive.ipynb

﻿{
    "metadata": {
        "kernelspec": {
            "name": "powershell",
            "display_name": "PowerShell"
        },
        "language_info": {
            "name": "powershell",
            "codemirror_mode": "shell",
            "mimetype": "text/x-sh",
            "file_extension": ".ps1"
        }
    },
    "nbformat_minor": 2,
    "nbformat": 4,
    "cells": [
        {"cell_type":"markdown","source":"# Chapter 1"},{"cell_type":"markdown","source":"# NameIT\r\n\r\nPowerShell module for randomly generating names.\r\n\r\n- [GitHub Repo](https://github.com/dfinke/NameIT)\r\n- [PowerShell Gallery](https://www.powershellgallery.com/packages/NameIT)\r\n\r\nTry it below, change the parameters passed, click run and see the results.\r\n\r\n## Install the Module\r\n\r\n"},{
    "cell_type":  "code",
    "source":  "\r\n# Install-Module NameIT -force\r\n",
    "metadata":  {
                     "azdata_cell_guid":  "9111a6f9-02c0-45b1-81b3-9101a5157b5c"
                 },
    "outputs":  [
                    {
                        "name":  "stdout",
                        "output_type":  "stream",
                        "text":  ""
                    }
                ]
},{"cell_type":"markdown","source":"\r\n## Getting Started\r\n\r\nLet\u0027s try it out.\r\n\r\n## Generate PowerShell Window Titles or Machine Names\r\n\r\n"},{
    "cell_type":  "code",
    "source":  "Invoke-Generate \"[Adjective]_[Noun]\" -Count 5\r\n",
    "metadata":  {
                     "azdata_cell_guid":  "31e9e694-7cab-4788-97bb-c28694f05329"
                 },
    "outputs":  [
                    {
                        "name":  "stdout",
                        "output_type":  "stream",
                        "text":  "Eminent_Plenty\r\nMushy_Pick\r\nNaughty_Chicken\r\nFierce_Code\r\nHabitual_Layer\r\n"
                    }
                ]
},{"cell_type":"markdown","source":"\r\n## Fake Data\r\n\r\nGenerate an eight character name with a random set of characters.\r\n\r\n"},{
    "cell_type":  "code",
    "source":  "Invoke-Generate\r\n",
    "metadata":  {
                     "azdata_cell_guid":  "43c2cc28-7064-4e98-80e3-8d800d32e310"
                 },
    "outputs":  [
                    {
                        "name":  "stdout",
                        "output_type":  "stream",
                        "text":  "emrqmirj\r\n"
                    }
                ]
},{"cell_type":"markdown","source":"\r\nGenerates an eight character name with a random set of characters in the A-Z alphabet. You can change which alphabet is being used by using the `-alphabet` parameter.\r\n\r\n"},{
    "cell_type":  "code",
    "source":  "Invoke-Generate -alphabet abc\r\n",
    "metadata":  {
                     "azdata_cell_guid":  "7f2ef443-931c-48ad-ab28-b9b383c0eef4"
                 },
    "outputs":  [
                    {
                        "name":  "stdout",
                        "output_type":  "stream",
                        "text":  "ccbbcbbc\r\n"
                    }
                ]
},{"cell_type":"markdown","source":"This is just a default template, most users will have some idea of what they want to generate, but want to randomly splice in other characters to make it unique or come up with some other ideas. For this you can provide a template string.\r\n\r\n"},{
    "cell_type":  "code",
    "source":  "Invoke-Generate \"cafe###\"\r\n",
    "metadata":  {
                     "azdata_cell_guid":  "a22f77c0-4a9d-43bc-aef7-9c2125e8984d"
                 },
    "outputs":  [
                    {
                        "name":  "stdout",
                        "output_type":  "stream",
                        "text":  "cafe007\r\n"
                    }
                ]
},{"cell_type":"markdown","source":"\r\nUsing the `?` symbol injects a random letter, the `#` symbol injects a random number.\r\n\r\n"},{
    "cell_type":  "code",
    "source":  "Invoke-Generate \"???###\"\r\n",
    "metadata":  {
                     "azdata_cell_guid":  "fb2ccb0d-9911-4ddc-a208-32aa9e2c613d"
                 },
    "outputs":  [
                    {
                        "name":  "stdout",
                        "output_type":  "stream",
                        "text":  "vbx598\r\n"
                    }
                ]
},{"cell_type":"markdown","source":"\r\n## Template Functions\r\nThe ```?``` and ```#``` characters in a template are just shorthand for functions that you can use in a template, so the previous example could also be written as:\r\n\r\n"},{
    "cell_type":  "code",
    "source":  "Invoke-Generate \"[alpha][alpha][alpha][numeric][numeric][numeric]\"\r\n",
    "metadata":  {
                     "azdata_cell_guid":  "14da1f25-7247-4692-bdf2-090a57c9d89d"
                 },
    "outputs":  [
                    {
                        "name":  "stdout",
                        "output_type":  "stream",
                        "text":  "ugb303\r\n"
                    }
                ]
},{"cell_type":"markdown","source":"NameIT exposes several useful functions to help create more useful (and pronounceable names). Here is the current list:\r\n\r\n- `[alpha]`; selects a random character (constrained by the ```-alphabet` parameter).\r\n- `[numeric]`; selects a random numeric (constrained by the `-numbers` parameter).\r\n- `[vowel]`; selects a vowel from *a*, *e*, *i*, *o* or *u*.\r\n- `[phoneticVowel]`; selects a vowel sound, for example *ou*.\r\n- `[consonant]`; selects a consonant from the entire alphabet.\r\n- `[syllable]`; generates (usually) a pronouncable single syllable.\r\n- `[synonym word]`; finds a synonym to match the provided word.\r\n- `[person]`; generate random name of female or male based on provided culture like \u0026lt;FirstName\u0026gt;\u0026lt;Space\u0026gt;\u0026lt;LastName\u0026gt;.\r\n- `[person female]`;generate random name of female based on provided culture like \u0026lt;FirstName\u0026gt;\u0026lt;Space\u0026gt;\u0026lt;LastName\u0026gt;.\r\n- `[person male]`;generate random name of male based on provided culture like \u0026lt;FirstName\u0026gt;\u0026lt;Space\u0026gt;\u0026lt;LastName\u0026gt;.\r\n- `[address]`; generate a random street address. Formatting is biased to US currently.\r\n- `[space]`; inserts a literal space. Spaces are striped from the templates string by default.\r\n\r\nOne of the most common functions you\u0027ll use is `[syllable()]` because it generally produces something that you can pronounce. For example, if we take our earlier cafe naming example, you might do something like this:\r\n\r\n"},{
    "cell_type":  "code",
    "source":  "Invoke-Generate \"cafe_[syllable][syllable]\"\r\n",
    "metadata":  {
                     "azdata_cell_guid":  "2d7355e6-1d3b-4fb0-b860-d8076e71887b"
                 },
    "outputs":  [
                    {
                        "name":  "stdout",
                        "output_type":  "stream",
                        "text":  "cafe_quyiw\r\n"
                    }
                ]
},{"cell_type":"markdown","source":"\r\nYou can also get the tool to generate more than one name at a time using the ```--count``` parameter. Here is an example:\r\n\r\n"},{
    "cell_type":  "code",
    "source":  "Invoke-Generate -count 5 \"[synonym cafe]_[syllable][syllable]\"\r\n",
    "metadata":  {
                     "azdata_cell_guid":  "47d0d2dc-865c-4c6d-9bd5-fcec680cfc73"
                 },
    "outputs":  [
                    {
                        "name":  "stdout",
                        "output_type":  "stream",
                        "text":  "coffeeshop_madec\r\neatingplace_paid\r\ncoffeehouse_ukpad\r\neatingplace_vute\r\neatinghouse_evta\r\n"
                    }
                ]
},{"cell_type":"markdown","source":"\r\n"}
    ]
}