Skip to content

marco97pa/Blackpink-Data

Repository files navigation

Action Forks Stargazers Issues Twitter


Logo

BLACKPINK Data

A Twitter bot that tweets the latest updates, pictures, stats and news about the korean girl group BLACKPINK.
Follow the Bot on Twitter

Explore the docs » · Report Bug · Request Feature

Table of Contents

  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact

About The Project

Screen Shot

A Twitter bot powered by AI that tweets the latest updates, pictures, stats and news about the korean girl group BLACKPINK.

The bot runs 24/7 on the Cloud thanks to GitHub Actions.

It uses a lot of sources to fetch the latest update about the group: Spotify, YouTube, Instagram, Twitter and more. Based on the data scraped from the web and the data already known (stored in a YAML file), the bot makes decisions and tweets updates.

The project is really modular and by editing the YAML file you can easily fork this repo and make a bot of another group or artist, with zero to minimal code changes.

Development suspended

Thanks to the latest updates of Twitter API pricing, the development and execution is suspended.
See #31 for further details

Built With

Getting Started

To get a copy up and running follow these simple steps.

Prerequisites

Make sure you have installed:

  • Python 3.8
  • pip

While not necessary, this project supports pyenv:
in that case all the python command will be 'python' instead of 'python3' and 'pip' instead of 'pip3'

Installation

  1. Clone the repo
    git clone https://github.com/marco97pa/Blackpink-Data.git
  2. Install requirements
    pip3 install -r requirements.txt
  3. Add the API KEYs
     export TWITTER_CONSUMER_KEY='xxxx'
     export TWITTER_CONSUMER_SECRET='xxxx'
     export TWITTER_ACCESS_KEY='xxxx'
     export TWITTER_ACCESS_SECRET='xxxx'
    
     export YOUTUBE_API_KEY='xxxx'
    
     export INSTAGRAM_ACCOUNT_USERNAME='xxxxxx'
     export INSTAGRAM_ACCOUNT_PASSWORD='xxxxxx'
    
     export SPOTIPY_CLIENT_ID='xxxx'
     export SPOTIPY_CLIENT_SECRET='xxxx'

For detailed instructions see the related page of the Documentation

Usage

You can launch the bot by running:
python3 main.py

For more details, please refer to the Run section of the Documentation

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

If you are adding a new module, please check the documentation and follow the style of other modules.

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Marco Fantauzzo - @data_blackpink - marco97pa@live.it

Project Link: https://github.com/marco97pa/Blackpink-Data