Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/atrox/haikunatorpy
Generate Heroku-like random names to use in your python applications
https://github.com/atrox/haikunatorpy
haikunator heroku python
Last synced: 1 day ago
JSON representation
Generate Heroku-like random names to use in your python applications
- Host: GitHub
- URL: https://github.com/atrox/haikunatorpy
- Owner: Atrox
- License: bsd-3-clause
- Created: 2015-03-06T12:59:25.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2018-01-30T11:33:46.000Z (almost 7 years ago)
- Last Synced: 2024-12-17T01:09:20.821Z (9 days ago)
- Topics: haikunator, heroku, python
- Language: Python
- Homepage: https://pypi.python.org/pypi/haikunator
- Size: 31.3 KB
- Stars: 127
- Watchers: 7
- Forks: 16
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# HaikunatorPY
[](https://travis-ci.org/Atrox/haikunatorpy)
[](https://pypi.python.org/pypi/haikunator)
[](https://coveralls.io/r/Atrox/haikunatorpy)
Generate Heroku-like random names to use in your python applications.
## Installation
```
pip install haikunator
```
## Usage
Haikunator is pretty simple. There is nothing to configure and it only has a single method, `haikunate`:
```python
from haikunator import Haikunator
haikunator = Haikunator()
# haikunator = Haikunator(seed='random seed') # optional seed
# default usage
haikunator.haikunate() # => "wispy-dust-1337"
# custom length (default=4)
haikunator.haikunate(token_length=6) # => "patient-king-887265"
# use hex instead of numbers
haikunator.haikunate(token_hex=True) # => "purple-breeze-98e1"
# use custom chars instead of numbers/hex
haikunator.haikunate(token_chars='HAIKUNATE') # => "summer-atom-IHEA"
# don't include a token
haikunator.haikunate(token_length=0) # => "cold-wildflower"
# use a different delimiter
haikunator.haikunate(delimiter='.') # => "restless.sea.7976"
# no token, space delimiter
haikunator.haikunate(token_length=0, delimiter=' ') # => "delicate haze"
# no token, empty delimiter
haikunator.haikunate(token_length=0, delimiter='') # => "billowingleaf"
```
## Options
The following options are available:
```python
from haikunator import Haikunator
haikunator = Haikunator(
adjectives=['custom', 'adjectives'],
nouns=['custom', 'nouns'],
seed='random seed'
)
haikunator.haikunate(
delimiter='-',
token_length=4,
token_hex=False,
token_chars='0123456789'
)
```
*If `token_hex` is true, any tokens specified in `token_chars` are ignored*
## Contributing
Everyone is encouraged to help improve this project. Here are a few ways you can help:
- [Report bugs](https://github.com/atrox/haikunatorpy/issues)
- Fix bugs and [submit pull requests](https://github.com/atrox/haikunatorpy/pulls)
- Write, clarify, or fix documentation
- Suggest or add new features
## Other Languages
Haikunator is also available in other languages. Check them out:
- Node: https://github.com/Atrox/haikunatorjs
- PHP: https://github.com/Atrox/haikunatorphp
- .NET: https://github.com/Atrox/haikunator.net
- Java: https://github.com/Atrox/haikunatorjava
- Go: https://github.com/Atrox/haikunatorgo
- Perl: https://github.com/Atrox/haikunatorperl
- Dart: https://github.com/Atrox/haikunatordart
- Ruby: https://github.com/usmanbashir/haikunator