names_generator
===============
.. image:: https://img.shields.io/badge/license-Apache-blue.svg?style=flat
:target: https://www.apache.org/licenses/LICENSE-2.0
:alt: License
.. image:: https://img.shields.io/pypi/v/names_generator.svg?style=flat&color=blue
:target: https://pypi.org/project/names_generator
:alt: PyPI Version
.. image:: https://img.shields.io/pypi/pyversions/names_generator.svg?logo=python&logoColor=white&style=flat
:target: https://pypi.org/project/names_generator
:alt: Python Versions
|
Clone of the Moby/Docker random name generator as a Python package.
Installation
------------
.. code-block:: bash
$ pip install names_generator
|
Usage
-----
|
Python API
^^^^^^^^^^
|
The API only really consists of a single function.
.. code-block:: python
>>> from names_generator import generate_name
>>> generate_name()
'vigorous_goldstine'
|
Customize the formatting of the name by specifying a `style`,
one of `plain`, `capital`, `hyphen`, or `underscore` (default).
.. code-block:: python
>>> generate_name(style='capital')
'Hardcore Thompson'
|
Pin a seed value for the underlying PRNG to reproduce a given name.
.. code-block:: python
>>> generate_name(seed=42) == generate_name(seed=42)
True
|
Command-line
^^^^^^^^^^^^
|
The package also exposes a basic command-line interface for scripting outside of Python
.. code-block:: bash
$ generate_name
clever_matsumoto
$ generate_name --style=capital
Heuristic Einstein
$ generate_name --help
usage: generate_name [-h] [-v] [--style NAME]
Generate random name pairing.
options:
-s, --style NAME Formatting (default: underscore).
-h, --help Show this message and exit.
-v, --version Show the version and exit.
Documentation and issue tracking at:
https://github.com/glentner/names_generator
Raw data
{
"_id": null,
"home_page": "https://github.com/glentner/names_generator",
"name": "names-generator",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "random name generator",
"author": "Geoffrey Lentner",
"author_email": "glentner@purdue.edu",
"download_url": "https://files.pythonhosted.org/packages/fd/de/60c26d1488db2ffdb050d2c0e6007998c2afd90760a4d7b23d32cde5b446/names_generator-0.2.0.tar.gz",
"platform": null,
"description": "names_generator\n===============\n\n.. image:: https://img.shields.io/badge/license-Apache-blue.svg?style=flat\n :target: https://www.apache.org/licenses/LICENSE-2.0\n :alt: License\n\n.. image:: https://img.shields.io/pypi/v/names_generator.svg?style=flat&color=blue\n :target: https://pypi.org/project/names_generator\n :alt: PyPI Version\n\n.. image:: https://img.shields.io/pypi/pyversions/names_generator.svg?logo=python&logoColor=white&style=flat\n :target: https://pypi.org/project/names_generator\n :alt: Python Versions\n\n|\n\nClone of the Moby/Docker random name generator as a Python package.\n\n\nInstallation\n------------\n\n.. code-block:: bash\n\n $ pip install names_generator\n\n|\n\nUsage\n-----\n\n|\n\nPython API\n^^^^^^^^^^\n\n|\n\nThe API only really consists of a single function.\n\n.. code-block:: python\n\n >>> from names_generator import generate_name\n >>> generate_name()\n 'vigorous_goldstine'\n\n|\n\nCustomize the formatting of the name by specifying a `style`,\none of `plain`, `capital`, `hyphen`, or `underscore` (default).\n\n.. code-block:: python\n\n >>> generate_name(style='capital')\n 'Hardcore Thompson'\n\n|\n\nPin a seed value for the underlying PRNG to reproduce a given name.\n\n.. code-block:: python\n\n >>> generate_name(seed=42) == generate_name(seed=42)\n True\n\n|\n\nCommand-line\n^^^^^^^^^^^^\n\n|\n\nThe package also exposes a basic command-line interface for scripting outside of Python\n\n.. code-block:: bash\n\n $ generate_name\n clever_matsumoto\n\n $ generate_name --style=capital\n Heuristic Einstein\n\n $ generate_name --help\n usage: generate_name [-h] [-v] [--style NAME]\n Generate random name pairing.\n\n options:\n -s, --style NAME Formatting (default: underscore).\n -h, --help Show this message and exit.\n -v, --version Show the version and exit.\n\n Documentation and issue tracking at:\n https://github.com/glentner/names_generator\n",
"bugtrack_url": null,
"license": "Apache License",
"summary": "Clone of the Moby/Docker random name generator as a Python package.",
"version": "0.2.0",
"project_urls": {
"Homepage": "https://github.com/glentner/names_generator"
},
"split_keywords": [
"random",
"name",
"generator"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "bf3d7210fc4b1999771b875d96ffa30cf4384c7fe8f0a7d9874df4b753b7703e",
"md5": "15a004f402e3e980c27b914e5daa7f22",
"sha256": "693e8e48e9a54a2a8f714b01d1bd70945743a15d4587059e7e4e16efc361be11"
},
"downloads": -1,
"filename": "names_generator-0.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "15a004f402e3e980c27b914e5daa7f22",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 26699,
"upload_time": "2024-04-16T03:38:54",
"upload_time_iso_8601": "2024-04-16T03:38:54.288078Z",
"url": "https://files.pythonhosted.org/packages/bf/3d/7210fc4b1999771b875d96ffa30cf4384c7fe8f0a7d9874df4b753b7703e/names_generator-0.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "fdde60c26d1488db2ffdb050d2c0e6007998c2afd90760a4d7b23d32cde5b446",
"md5": "41413151bb4ed28da928eb07371e8831",
"sha256": "de60e354b8ca8f2d1ce0816079d3ba569417371867b94328021f03c9dd47a5be"
},
"downloads": -1,
"filename": "names_generator-0.2.0.tar.gz",
"has_sig": false,
"md5_digest": "41413151bb4ed28da928eb07371e8831",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 27106,
"upload_time": "2024-04-16T03:38:58",
"upload_time_iso_8601": "2024-04-16T03:38:58.399166Z",
"url": "https://files.pythonhosted.org/packages/fd/de/60c26d1488db2ffdb050d2c0e6007998c2afd90760a4d7b23d32cde5b446/names_generator-0.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-16 03:38:58",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "glentner",
"github_project": "names_generator",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "names-generator"
}
JSON
