A Python package for building names by using other names as building blocks.
It started with an update to a blackjack game I wrote as my first project in Python. I wanted to have a bunch of computer players playing with you, and thought they should be randomly generated with randomly generated names. Then it came up in a few other things I wrote, so I figured I'd turn it into a package.
It pulls random names from a database, and can modify those names before returning them. Major features include:
- Use parts of multiple names to construct a new name.
- Modify the selected or constructed names.
- Use a default database of names.
- Use your own database of names.
- Import into your Python code as a package.
- Use from the command line.
The easiest way to install and run mkname is:
- Ensure you are using Python 3.10 or higher.
- Install from PyPI using pip: pip install mkname
- Run the following command to see the options: mkname -h
It should also be able to be imported into your Python code as a package.
The following changes were made in v0.2.3:
- Fixed automatic creation of database connections.
I'm using the pytest library for the unit tests. To just run those tests, go to the root of your clone of the mkname repository and use the following command:
python3 -m pytest
The full suite of style checks, mypy, and such I use can be run using a shortcut I have set up in the Makefile:
make pre
Note: precommit.py requires itself to be run from a virtual environment located in the .venv directory at the root of the repository. This is so I don't accidentally run it using my system's Python and then waste hours troubleshooting that mess. If you want to disable this, you'll have to modify the script. The easiest way is probably commenting out the check_venv() call in main().