https://github.com/glentner/names_generator

Clone of the Moby/Docker random name generator as a Python package.
https://github.com/glentner/names_generator

random-name-generator

Last synced: 15 days ago
JSON representation

Clone of the Moby/Docker random name generator as a Python package.

• Host: GitHub
• URL: https://github.com/glentner/names_generator
• Owner: glentner
• License: apache-2.0
• Created: 2020-12-03T00:29:52.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2024-04-16T03:40:12.000Z (about 1 year ago)
• Last Synced: 2025-05-07T23:07:52.947Z (15 days ago)
• Topics: random-name-generator
• Language: Python
• Homepage:
• Size: 63.5 KB
• Stars: 25
• Watchers: 2
• Forks: 7
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE

Awesome Lists containing this project

README

        
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