Pufo Twitter Bot πŸ›Έοƒ

PyPI Python Version License

Read the documentation at https://pufo-twitter-bot.readthedocs.io/ Tests Codecov

pre-commit Black

Features πŸš€οƒ

This is an command-line app to create randomly created book titles to author combinations. The interface provides the possibility to tweet the list on twitter.

  • Creates a list of random book titels and author combinations

  • Parameters to tune are

    • count for number of author/titles

    • gender for the gender of the authors

Book titles are in german for now. Multilanguage support maybe coming in the future.

Requirements πŸ“‹οƒ

  • python>=3.7,<3.10

  • twitter devloper account (to post to twitter)

Installation πŸ”¨οƒ

You can install Pufo Twitter Bot via pip from PyPI:

$ pip install pufo-twitter-bot

Usage

Basic usage:

$ pufo-twitter-bot --count 2 --gender m
>> 1. Der BΓΌffel - Florentin Titze
>> 2. Platte TΓΌte - Stefan Will

Please see the Command-line Reference for details.

Contributing

Contributions are very welcome. To learn more, see the Contributor Guide.

License

Distributed under the terms of the MIT license, Pufo Twitter Bot is free and open source software.

Issues πŸ“Œοƒ

If you encounter any problems, please file an issue along with a detailed description.

Credits

Random book titles are taken from buchtitelgenerator.de This project would not be possible without the authors of this site for letting me use their data. Herewith I express my deepest thanks.

Random author names generated from two origins:

The names data is distributed under the Creative Commons license (see: cc licenses)

Support

Get me a coffee β˜• or beer 🍺

This project was generated from @cjolowicz’s Hypermodern Python Cookiecutter template.