General Words
=============
.. image:: https://badge.fury.io/py/generalwords.png
:target: http://badge.fury.io/py/generalwords
.. image:: https://travis-ci.org/petrilli/generalwords.png?branch=master
:target: https://travis-ci.org/petrilli/generalwords
.. image:: https://pypip.in/d/generalwords/badge.png
:target: https://pypi.python.org/pypi/generalwords
Often, when building an application, I've had occasions where I need to provide
a nonce of some sort to a user. A nonce is some thing, whether number, or
otherwise, that is used only once.
Goals
-----
The over-arching goal was for this to be simple to use,
and reasonably fast. Next, I wanted something that the average user would be
able to enter manually with minimal risk. This ruled out a lot of the crazy
mixed-case alphanumeric strings that are often used. Finally,
a goal was to have a reasonably large number of permutations available so
that the nonce, while not cryptographically strong, was strong enough for
uses like registration, password reset, etc. For example, with the default
`word source`_, and a selection of three words, there are
`almost 19 billion permutations`_ available. Presuming you're doing any form
of brute-force-attack prevention, this should be more than adequate.
.. _almost 19 billion permutations: http://www.wolframalpha.com/input/?i=number+of+3+permutations+of+2668+objects
Word Source
-----------
The list of words comes from the `New General Service List`_ v1.01. The original
list, distributed in Excel format, is covered under the
`Creative Commons Attribution 3.0 Unported License`_. More information can be
found on the website. From the base data, the following changes have been made:
#. The list was converted from Excel to a simple one-word-per-line text file
format;
2. Only headwords were retained for clarity;
3. Supplemental words, such as months and numbers, were added;
3. Words less than 4 characters were removed.
Combined, a total of 2,668 headwords were retained.
.. _New General Service List: http://www.newgeneralservicelist.org/
.. _Creative Commons Attribution 3.0 Unported License: http://creativecommons.org/licenses/by/3.0/deed.en_US
Usage Example
-------------
The library is trivially easy to use::
>>> from generalwords import *
>>> get_word()
'tire'
>>> get_word()
'offense'
>>> get_words(n=3)
('climb', 'repair', 'force')
In the future, there may be more options, but not right now.
Not Done Yet
------------
While the library will never be massively complicated, there's a few things I'd
like to have in the future:
* Expand to other languages
* Add additional word sources
History
-------
0.1.0 (2015-55)
---------------------
* First release on PyPI.
Metadata
Release files for generalwords 1.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| generalwords-1.0.tar.gz | 17.2 kB | Without provenance | Details for generalwords-1.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| generalwords-1.0-py2.py3-none-any.whl | Python 3, Python 2 | none | any | Details for generalwords-1.0-py2.py3-none-any.whl |
Total release size: 33.6 kB
Release files / generalwords-1.0.tar.gz
| Download URL | generalwords-1.0.tar.gz |
|---|---|
| Size | 17.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
9f97cf25650b0c419e9b9c5ff02a779333c663daa769b14f63dfe3d7cdbf6676
|
|
BLAKE2b-256 checksum How to use checksums |
08f95cff6765cff09f2725bc6b74d57491cf27c07e8d2d81f66ef53f889648d9
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
Release files / generalwords-1.0-py2.py3-none-any.whl
| Download URL | generalwords-1.0-py2.py3-none-any.whl |
|---|---|
| Size | 16.4 kB |
| Tags | Python 2 Python 3 |
|
SHA-256 checksum How to use checksums |
1dadab589b074368ae347c26dbf174aac33258306e6956971a49652b741b01d5
|
|
BLAKE2b-256 checksum How to use checksums |
0dfb2f44ea95e49ad8e893ca9ebb5d5fbe91ba0d0f9a41cc479d1f6ef834fa9f
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
Security for generalwords 1.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.