prefect-twitter

Important Notice: prefect-twitter is no longer actively maintained. For more details, please see the Maintenance Status section below.

Maintenance Status

prefect-twitter has been a valuable part of the Prefect ecosystem. Due to shifts in our strategic priorities, we have decided to discontinue the active maintenance of this library. While we will not be updating the code or addressing issues, the existing codebase will remain accessible for archival purposes. We appreciate the support and contributions from our community.

Visit the full docs here to see additional examples and the API reference.

Prefect integrations for interacting with Twitter.

Resources

For more tips on how to use tasks and flows in a Collection, check out Using Collections!

Installation

Install prefect-twitter with pip:

pip install prefect-twitter

Requires an installation of Python 3.7+.

We recommend using a Python virtual environment manager such as pipenv, conda or virtualenv.

These tasks are designed to work with Prefect 2. For more information about how to use Prefect, please refer to the Prefect documentation.

Write and run a flow

Tweets an update with just text.

from prefect import flow
from prefect_twitter import TwitterCredentials
from prefect_twitter.tweets import update_status

@flow
def example_update_status_flow():
    twitter_credentials = TwitterCredentials(
        consumer_key="consumer_key",
        consumer_secret="consumer_secret",
        access_token="access_token",
        access_token_secret="access_token_secret"
    )
    status_id = update_status(twitter_credentials, status="A Prefect Tweet!")
    return status_id

example_update_status_flow()

Feedback

If you encounter and bugs while using prefect-twitter, feel free to open an issue in the prefect-twitter repository.

If you have any questions or issues while using prefect-twitter, you can find help in either the Prefect Discourse forum or the Prefect Slack community.

Feel free to star or watch prefect-twitter for updates too!

Development

Contributing

If you'd like to help contribute to fix an issue or add a feature to prefect-twitter, please propose changes through a pull request from a fork of the repository.

Here are the steps:

1. Fork the repository
2. Clone the forked repository
3. Install the repository and its dependencies:

pip install -e ".[dev]"

4. Make desired changes
5. Add tests
6. Insert an entry to CHANGELOG.md
7. Install pre-commit to perform quality checks prior to commit:

 pre-commit install

8. git commit, git push, and create a pull request