names
=====
.. image:: https://secure.travis-ci.org/treyhunner/names.png?branch=master
:target: http://travis-ci.org/treyhunner/names
.. image:: https://coveralls.io/repos/treyhunner/names/badge.png?branch=master
:target: https://coveralls.io/r/treyhunner/names
Random name generator
Installation
------------
The script is `available on PyPI`_. To install with pip::
sudo pip install names
Usage
-----
Names can be used as a command line utility or imported as a Python package.
Command Line Usage
~~~~~~~~~~~~~~~~~~
To use the script from the command line:
.. code-block:: bash
$ names
John Powell
Python Package Usage
~~~~~~~~~~~~~~~~~~~~
Here are examples of all current features:
.. code-block:: pycon
>>> import names
>>> names.get_full_name()
u'Patricia Halford'
>>> names.get_full_name(gender='male')
u'Patrick Keating'
>>> names.get_first_name()
'Bernard'
>>> names.get_first_name(gender='female')
'Christina'
>>> names.get_last_name()
'Szczepanek'
License
-------
This project is released under an `MIT License`_.
Data in the following files are public domain (derived from 1990 Census data):
- dist.all.last
- dist.female.first
- dist.male.first
.. _mit license: http://th.mit-license.org/2013
.. _available on PyPI: http://pypi.python.org/pypi/names/
Changes
=======
0.3.0 (2013-05-14)
------------------
- Fixed Python 3 support
- Improved tests and fixed minor bugs
0.2 (2013-02-17)
----------------
- Initial release
Contributing
============
Please file bugs to the `Github issue tracker`_. Pull requests are welcome.
.. _Github issue tracker: https://github.com/treyhunner/names/issues
Hacking and Pull Requests
-------------------------
Please try to conform to `PEP8`_ for code contributions and ensure that the
tests continue to function.
Please include new tests with your pull requests when appropriate.
Running the tests
~~~~~~~~~~~~~~~~~
You will need `tox`_ and `coverage`_ installed to run the tests on your code:
.. code-block:: bash
$ pip install tox coverage
To run the tests and generate a coverage report:
.. code-block:: bash
$ ./runtests.sh
The coverage output should look similar to this::
_____________________ summary _____________________
py27: commands succeeded
py32: commands succeeded
py33: commands succeeded
pypy: commands succeeded
flake8: commands succeeded
congratulations :)
Name Stmts Miss Branch BrMiss Cover
--------------------------------------------------
names/__init__ 25 0 8 0 100%
names/main 4 0 0 0 100%
--------------------------------------------------
TOTAL 29 0 8 0 100%
.. _pep8: http://www.python.org/dev/peps/pep-0008/
.. _tox: http://testrun.org/tox/latest/
.. _coverage: https://pypi.python.org/pypi/coverage/
Raw data
{
"_id": null,
"home_page": "https://github.com/treyhunner/names",
"name": "names",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": null,
"author": "Trey Hunner",
"author_email": "UNKNOWN",
"download_url": "https://files.pythonhosted.org/packages/44/4e/f9cb7ef2df0250f4ba3334fbdabaa94f9c88097089763d8e85ada8092f84/names-0.3.0.tar.gz",
"platform": "UNKNOWN",
"description": "names\n=====\n\n.. image:: https://secure.travis-ci.org/treyhunner/names.png?branch=master\n :target: http://travis-ci.org/treyhunner/names\n.. image:: https://coveralls.io/repos/treyhunner/names/badge.png?branch=master\n :target: https://coveralls.io/r/treyhunner/names\n\nRandom name generator\n\n\nInstallation\n------------\n\nThe script is `available on PyPI`_. To install with pip::\n\n sudo pip install names\n\n\nUsage\n-----\n\nNames can be used as a command line utility or imported as a Python package.\n\nCommand Line Usage\n~~~~~~~~~~~~~~~~~~\nTo use the script from the command line:\n\n.. code-block:: bash\n\n $ names\n John Powell\n\nPython Package Usage\n~~~~~~~~~~~~~~~~~~~~\nHere are examples of all current features:\n\n.. code-block:: pycon\n\n >>> import names\n >>> names.get_full_name()\n u'Patricia Halford'\n >>> names.get_full_name(gender='male')\n u'Patrick Keating'\n >>> names.get_first_name()\n 'Bernard'\n >>> names.get_first_name(gender='female')\n 'Christina'\n >>> names.get_last_name()\n 'Szczepanek'\n\n\nLicense\n-------\n\nThis project is released under an `MIT License`_.\n\nData in the following files are public domain (derived from 1990 Census data):\n\n- dist.all.last\n- dist.female.first\n- dist.male.first\n\n.. _mit license: http://th.mit-license.org/2013\n.. _available on PyPI: http://pypi.python.org/pypi/names/\n\n\nChanges\n=======\n\n0.3.0 (2013-05-14)\n------------------\n\n- Fixed Python 3 support\n- Improved tests and fixed minor bugs\n\n\n0.2 (2013-02-17)\n----------------\n\n- Initial release\n\n\nContributing\n============\n\nPlease file bugs to the `Github issue tracker`_. Pull requests are welcome.\n\n.. _Github issue tracker: https://github.com/treyhunner/names/issues\n\n\nHacking and Pull Requests\n-------------------------\n\nPlease try to conform to `PEP8`_ for code contributions and ensure that the\ntests continue to function.\n\nPlease include new tests with your pull requests when appropriate.\n\nRunning the tests\n~~~~~~~~~~~~~~~~~\n\nYou will need `tox`_ and `coverage`_ installed to run the tests on your code:\n\n.. code-block:: bash\n\n $ pip install tox coverage\n\nTo run the tests and generate a coverage report:\n\n.. code-block:: bash\n\n $ ./runtests.sh\n\nThe coverage output should look similar to this::\n\n _____________________ summary _____________________\n py27: commands succeeded\n py32: commands succeeded\n py33: commands succeeded\n pypy: commands succeeded\n flake8: commands succeeded\n congratulations :)\n Name Stmts Miss Branch BrMiss Cover\n --------------------------------------------------\n names/__init__ 25 0 8 0 100%\n names/main 4 0 0 0 100%\n --------------------------------------------------\n TOTAL 29 0 8 0 100%\n\n.. _pep8: http://www.python.org/dev/peps/pep-0008/\n.. _tox: http://testrun.org/tox/latest/\n.. _coverage: https://pypi.python.org/pypi/coverage/",
"bugtrack_url": null,
"license": "MIT",
"summary": "Generate random names",
"version": "0.3.0",
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"md5": "64e8e6d66583863fd7c43d9ea62991d3",
"sha256": "726e46254f2ed03f1ffb5d941dae3bc67c35123941c29becd02d48d0caa2a671"
},
"downloads": -1,
"filename": "names-0.3.0.tar.gz",
"has_sig": false,
"md5_digest": "64e8e6d66583863fd7c43d9ea62991d3",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 789099,
"upload_time": "2013-05-14T14:55:49",
"upload_time_iso_8601": "2013-05-14T14:55:49.073301Z",
"url": "https://files.pythonhosted.org/packages/44/4e/f9cb7ef2df0250f4ba3334fbdabaa94f9c88097089763d8e85ada8092f84/names-0.3.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2013-05-14 14:55:49",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "treyhunner",
"github_project": "names",
"travis_ci": true,
"coveralls": true,
"github_actions": false,
"tox": true,
"lcname": "names"
}
JSON
