codenamegenerator/README.md

54 lines
1.6 KiB
Markdown
Raw Normal View History

2019-10-19 06:58:01 +00:00
# codenamegenerator
2019-10-19 06:22:53 +00:00
2019-10-19 06:58:01 +00:00
This is a python module that generates random codenames for projects.
A basic command, as well as a simple HTTP API server, are included.
2019-10-19 06:22:53 +00:00
2019-10-19 06:28:52 +00:00
I have intentionally excluded words that are long, confusing, hard to spell,
as well as occupations, animal names with negative connotations, and some
foods and body parts in an attempt to avoid randomly generating negative,
threatening, or disgusting code names.
2019-10-19 07:16:02 +00:00
This module uses nothing but the python3 standard library.
2019-10-19 07:08:00 +00:00
# Rationale
* [What M&A code names are and why investment banks use
them](https://corporatefinanceinstitute.com/resources/knowledge/deals/project-names-in-investment-banking/)
* [WSJ: Project Funway: Code Names Help Spice Up the Art of the
Deal](https://www.wsj.com/articles/bankers-lament-loss-of-code-names-for-deals-1409279749)
2019-10-19 06:58:01 +00:00
# Run
Clone the repo, then run `PYTHONPATH=. python3 bin/server` inside it.
2019-10-19 06:51:46 +00:00
# Demo
2019-11-08 15:59:52 +00:00
An instance of `master` should be running at [https://codenames.apps.sneak.run](https://codenames.apps.sneak.run).
2019-10-19 06:51:46 +00:00
2019-10-19 06:22:53 +00:00
# See Also
2019-10-19 06:53:07 +00:00
* [docker
2019-10-19 06:22:53 +00:00
names-generator](https://github.com/moby/moby/blob/master/pkg/namesgenerator/names-generator.go)
2019-10-19 06:53:07 +00:00
* [Generate-Codename (perl, 2011)](https://github.com/sneak/Generate-Codename)
2019-10-19 06:22:53 +00:00
2019-10-19 06:58:01 +00:00
# Invitation
You are invited to contribute to this repository. Pull requests that
introduce additional words for the lists are welcome, but please keep it
simple.
2019-10-19 06:22:53 +00:00
# Author
Jeffrey Paul <sneak@sneak.berlin>
https://sneak.berlin
[@sneakdotberlin](https://twitter.com/sneakdotberlin)
`5539 AD00 DE4C 42F3 AFE1 1575 0524 43F4 DF2A 55C2`
# License
This code is released into the public domain.