queb名称生成器
qng的Python项目详细描述
documentation aussi disponible enfrançais
qng，queb名称生成器。
要求
要运行qng，您只需要python≥3.4。
对于安装，我们建议使用pippackage manager。
安装
要在系统范围内安装qng，请运行：
sudo pip3 install qng
要从源代码手动安装qng，步骤如下：
git clone git@github.com:abusque/qng.git
cd qng
sudo ./setup.py install
使用
安装后，您可以通过运行以下命令使用qng：
qng
这将生成一个随机的queb名称。
您还可以为特定性别生成名称：
qng --gender male
仅生成名称的一部分：
qng --part first
根据相对受欢迎程度生成名称：
qng --weighted
生成格式为“snake_case”的名称，不带任何变音符号 （用于命名容器）：
qng --snake-case
下面是如何使用它命名Docker容器的：
docker run --name $(qng --snake-case) hello-world
如果需要，可以将以上所有选项组合在一起。参考帮助 有关详细信息：
qng --help
python api
您还可以通过其python api使用qng与 其他应用。
下面是一个简单的编程用法示例：
importqng.generatorgenerator=qng.generator.QuebNameGenerator()name=generator.generate()print(name)
generate()函数还支持以下选项 与相应的cli选项含义相同：
importqng.generatorgenerator=qng.generator.QuebNameGenerator()name=generator.generate(gender='male',part='first',snake_case=True,weighted=True,)print(name)
有关详细信息，请参阅源文件中的文档。
开发
对于qng的本地开发，您可以使用 pipenv。使用pipenv install --dev到 生成一个虚拟环境，依赖项将在其中 安装。然后可以使用pipenv shell激活 环境。
对于将发行版发布到pypi，我们建议使用 Twine。
参考文献
qng的数据来自l’institut de la statistique 对于姓氏，从PrénomsQuébec.ca开始对于名字（谁在 反过来从魁北克的重新培训中心获取他们的数据。
可以找到用于从网页中删除数据的脚本 在scripts/目录下。
欢迎加入QQ群-->： 979659372
