Welcome to Awesome Codename’s documentation!¶
Contents:
Awesome Codename¶
Awesome Codename Generator
- Free software: AGPL v3 license
- Documentation: https://awesome-codename.readthedocs.org.
- Python versions: 2.7, 3.4+
Features¶
Generates awesome codenames :)
Quickstart¶
You can use the generate_codename() function and pick your favorite:
>>> from awesome_codename import generate_codename
>>> generate_codename()
'abnormal keeper'
>>> generate_codename()
'altruistic supermodel'
>>> generate_codename()
'recovered image'
Or run awesome-codename from the command line:
$ awesome-codename 3
square thermometer
best shaker
countywide fusion
Credits¶
All credits go to SecureDrop project for curating the list of adjectives and nouns.
This package was created with Cookiecutter and the rolando/cookiecutter-pypackage project template.
Installation¶
Stable release¶
To install Awesome Codename, run this command in your terminal:
$ pip install awesome-codename
If you don’t have pip installed, this Python installation guide can guide you through the process.
From sources¶
The sources for Awesome Codename can be downloaded from the Github repo.
You can either clone the public repository:
$ git clone git://github.com/rolando/awesome-codename
Or download the tarball:
$ curl -OL https://github.com/rolando/awesome-codename/tarball/master
Once you have a copy of the source, you can install it with:
$ pip install -e .