######
mkname
######
A Python package for building names by using other names as building
blocks.
Why?
====
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.
What does it do?
================
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.
How do I run it?
================
The easiest way to install and run `mkname` is:
1. Ensure you are using Python 3.10 or higher.
2. Install from PyPI using pip: `pip install mkname`
3. 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.
What Changed in Version 0.2.3
=============================
The following changes were made in v0.2.3:
* (To-Do) Fixed automatic creation of database connections.
How do I run the tests?
=======================
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()`.
Raw data
{
"_id": null,
"home_page": "https://github.com/pji/mkname",
"name": "mkname",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": "",
"keywords": "",
"author": "Paul J. Iutzi",
"author_email": "pji@mac.com",
"download_url": "https://files.pythonhosted.org/packages/31/e4/b8fe5173a0e53495dc6f528ad1e04b2025409d85f705ff614e0e9dc65148/mkname-0.2.3.tar.gz",
"platform": null,
"description": "######\nmkname\n######\n\nA Python package for building names by using other names as building\nblocks.\n\n\nWhy?\n====\nIt started with an update to a blackjack game I wrote as my first\nproject in Python. I wanted to have a bunch of computer players\nplaying with you, and thought they should be randomly generated\nwith randomly generated names. Then it came up in a few other things\nI wrote, so I figured I'd turn it into a package.\n\n\nWhat does it do?\n================\nIt pulls random names from a database, and can modify those names\nbefore returning them. Major features include:\n\n* Use parts of multiple names to construct a new name.\n* Modify the selected or constructed names.\n* Use a default database of names.\n* Use your own database of names.\n* Import into your Python code as a package.\n* Use from the command line.\n\n\nHow do I run it?\n================\nThe easiest way to install and run `mkname` is:\n\n1. Ensure you are using Python 3.10 or higher.\n2. Install from PyPI using pip: `pip install mkname`\n3. Run the following command to see the options: `mkname -h`\n\nIt should also be able to be imported into your Python code as a package.\n\n\nWhat Changed in Version 0.2.3\n=============================\nThe following changes were made in v0.2.3:\n\n* (To-Do) Fixed automatic creation of database connections.\n\n\nHow do I run the tests?\n=======================\nI'm using the `pytest` library for the unit tests. To just run those tests,\ngo to the root of your clone of the `mkname` repository and use the following\ncommand::\n\n python3 -m pytest\n\nThe full suite of style checks, mypy, and such I use can be run using a\nshortcut I have set up in the Makefile::\n\n make pre\n\nNote: `precommit.py` requires itself to be run from a virtual environment\nlocated in the `.venv` directory at the root of the repository. This is so\nI don't accidentally run it using my system's Python and then waste hours\ntroubleshooting that mess. If you want to disable this, you'll have to\nmodify the script. The easiest way is probably commenting out the\n`check_venv()` call in `main()`.\n",
"bugtrack_url": null,
"license": "",
"summary": "A random name generation script.",
"version": "0.2.3",
"project_urls": {
"Bug Tracker": "https://github.com/pji/mkname/issues",
"Homepage": "https://github.com/pji/mkname"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "672c85a089909800246439ea8c42c7855a714238b0abc7c956b6737e69aa1af2",
"md5": "4cb6ef5a57d563286424014030881e63",
"sha256": "99269208c4924a750e1d8088aacc8a771be0c1794e4c6383e2b4fd775ceda8f5"
},
"downloads": -1,
"filename": "mkname-0.2.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "4cb6ef5a57d563286424014030881e63",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 25215,
"upload_time": "2023-08-21T12:42:33",
"upload_time_iso_8601": "2023-08-21T12:42:33.732074Z",
"url": "https://files.pythonhosted.org/packages/67/2c/85a089909800246439ea8c42c7855a714238b0abc7c956b6737e69aa1af2/mkname-0.2.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "31e4b8fe5173a0e53495dc6f528ad1e04b2025409d85f705ff614e0e9dc65148",
"md5": "42ff1381b6a0667e6b01d3e80f22198c",
"sha256": "5019744474646788fb77a959e8ffd9f08c9554f284de08d5454c9c305cec7541"
},
"downloads": -1,
"filename": "mkname-0.2.3.tar.gz",
"has_sig": false,
"md5_digest": "42ff1381b6a0667e6b01d3e80f22198c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 30020,
"upload_time": "2023-08-21T12:42:35",
"upload_time_iso_8601": "2023-08-21T12:42:35.394965Z",
"url": "https://files.pythonhosted.org/packages/31/e4/b8fe5173a0e53495dc6f528ad1e04b2025409d85f705ff614e0e9dc65148/mkname-0.2.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-08-21 12:42:35",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "pji",
"github_project": "mkname",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [
{
"name": "yadr",
"specs": [
[
"==",
"0.1.3"
]
]
}
],
"lcname": "mkname"
}
JSON
