Skip to content

Latest commit

 

History

History
189 lines (131 loc) · 5.87 KB

README.md

File metadata and controls

189 lines (131 loc) · 5.87 KB
Raw

Contributors Forks Stargazers Issues MIT License


Text people new tweets

Do your friends not have a Twitter but you still want to share them your hilarious tweets? Look no further! This will automatically send the people you added the tweet as a text message whenever you tweet!

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

Built With

Getting Started

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

Prerequisites

  • Pipenv 
    pip install pipenv

Pip should be fine as well. The only package to be installed is python-twitter

Installation

  1. Clone the repo

    git clone https://github.com/viraatdas/Text-New-Tweets.git

  2. Pipenv environment - or you can use Pip

    pipenv install

  3. Environment file

    mv config_template.py config.py

  4. Access and API tokens for the Twitter API

  5. Update the values in config.py accordingly

Usage

python3 send_text.py

config.py can be edited while the code is running. If you look at send_text.py, I reload config every time there is a call to the Twitter API. Hopefully this makes it easy to add or remove phone numbers.

The code runs every 15 minutes. If there is a new tweet sent, it sends that out otherwise waits 15 minutes again.

If the tweet ends with a "*", then it won't be texted to the users.

Deploy - Example

I decided to use a free EC2 instance. Using the screen command, I simply let the code run in perpetuity.

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

License

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

Contact

Viraat - @therealviraat - viraat.laldas@gmail.com

README template based on othneildrew