├── .github └── workflows │ ├── publish.yml │ └── test.yml ├── .gitignore ├── LICENSE ├── README.md ├── setup.py ├── tests └── test_tweet_images.py └── tweet_images ├── __init__.py └── cli.py /.github/workflows/publish.yml: -------------------------------------------------------------------------------- 1 | name: Publish Python Package 2 | 3 | on: 4 | release: 5 | types: [created] 6 | 7 | jobs: 8 | test: 9 | runs-on: ubuntu-latest 10 | strategy: 11 | matrix: 12 | python-version: ["3.7", "3.8", "3.9", "3.10"] 13 | steps: 14 | - uses: actions/checkout@v2 15 | - name: Set up Python ${{ matrix.python-version }} 16 | uses: actions/setup-python@v2 17 | with: 18 | python-version: ${{ matrix.python-version }} 19 | - uses: actions/cache@v2 20 | name: Configure pip caching 21 | with: 22 | path: ~/.cache/pip 23 | key: ${{ runner.os }}-pip-${{ hashFiles('**/setup.py') }} 24 | restore-keys: | 25 | ${{ runner.os }}-pip- 26 | - name: Install dependencies 27 | run: | 28 | pip install -e '.[test]' 29 | - name: Run tests 30 | run: | 31 | pytest 32 | deploy: 33 | runs-on: ubuntu-latest 34 | needs: [test] 35 | steps: 36 | - uses: actions/checkout@v2 37 | - name: Set up Python 38 | uses: actions/setup-python@v2 39 | with: 40 | python-version: "3.10" 41 | - uses: actions/cache@v2 42 | name: Configure pip caching 43 | with: 44 | path: ~/.cache/pip 45 | key: ${{ runner.os }}-publish-pip-${{ hashFiles('**/setup.py') }} 46 | restore-keys: | 47 | ${{ runner.os }}-publish-pip- 48 | - name: Install dependencies 49 | run: | 50 | pip install setuptools wheel twine build 51 | - name: Publish 52 | env: 53 | TWINE_USERNAME: __token__ 54 | TWINE_PASSWORD: ${{ secrets.PYPI_TOKEN }} 55 | run: | 56 | python -m build 57 | twine upload dist/* 58 | 59 | -------------------------------------------------------------------------------- /.github/workflows/test.yml: -------------------------------------------------------------------------------- 1 | name: Test 2 | 3 | on: [push] 4 | 5 | jobs: 6 | test: 7 | runs-on: ubuntu-latest 8 | strategy: 9 | matrix: 10 | python-version: ["3.7", "3.8", "3.9", "3.10"] 11 | steps: 12 | - uses: actions/checkout@v2 13 | - name: Set up Python ${{ matrix.python-version }} 14 | uses: actions/setup-python@v2 15 | with: 16 | python-version: ${{ matrix.python-version }} 17 | - uses: actions/cache@v2 18 | name: Configure pip caching 19 | with: 20 | path: ~/.cache/pip 21 | key: ${{ runner.os }}-pip-${{ hashFiles('**/setup.py') }} 22 | restore-keys: | 23 | ${{ runner.os }}-pip- 24 | - name: Install dependencies 25 | run: | 26 | pip install -e '.[test]' 27 | - name: Run tests 28 | run: | 29 | pytest 30 | 31 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | .venv 2 | __pycache__/ 3 | *.py[cod] 4 | *$py.class 5 | venv 6 | .eggs 7 | .pytest_cache 8 | *.egg-info 9 | .DS_Store 10 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # tweet-images 2 | 3 | [![PyPI](https://img.shields.io/pypi/v/tweet-images.svg)](https://pypi.org/project/tweet-images/) 4 | [![Changelog](https://img.shields.io/github/v/release/simonw/tweet-images?include_prereleases&label=changelog)](https://github.com/simonw/tweet-images/releases) 5 | [![Tests](https://github.com/simonw/tweet-images/workflows/Test/badge.svg)](https://github.com/simonw/tweet-images/actions?query=workflow%3ATest) 6 | [![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://github.com/simonw/tweet-images/blob/master/LICENSE) 7 | 8 | Send tweets with images from the command line 9 | 10 | ## Installation 11 | 12 | Install this tool using `pip`: 13 | 14 | pip install tweet-images 15 | 16 | ## Example 17 | 18 | This tool is used by the [@covidsewage](https://twitter.com/covidsewage) bot on Twitter, see [simonw/covidsewage-bot](https://github.com/simonw/covidsewage-bot) and [Building a Covid sewage Twitter bot](https://simonwillison.net/2022/Apr/18/covid-sewage/). 19 | 20 | ## Usage 21 | 22 | You'll need a consumer key, consumer secret, access token key and access token secret for a Twitter account that you wish to tweet from. See [How to get credentials for a new Twitter bot](https://til.simonwillison.net/twitter/credentials-twitter-bot) for tips on obtaining these. 23 | 24 | You can pass those as the `--consumer-key`, `--consumer-secret`, `--access-token-key`, `--access-token-secret` options to the command, or you can set them as environment variables like this: 25 | ``` 26 | export TWITTER_CONSUMER_KEY="..." 27 | export TWITTER_CONSUMER_SECRET="..." 28 | export TWITTER_ACCESS_TOKEN_KEY="..." 29 | export TWITTER_ACCESS_TOKEN_SECRET=".." 30 | ``` 31 | 32 | You can then send a tweet like this: 33 | 34 | tweet-images "This is my tweet" 35 | 36 | Or attach between one and four images to that tweet by passing their file paths: 37 | 38 | tweet-images "Three pictures attached" one.jpg two.jpg three.jpg 39 | 40 | You can pass `--alt "alt text"` one or more times to attach alt text to your images: 41 | 42 | tweet-images "Three pictures attached" one.jpg two.jpg \ 43 | --alt "Alt text for one" --alt "Alt text for two" 44 | 45 | ## Using this with GitHub Actions 46 | 47 | Here's an example fragment from [a GitHub Actions workflow](https://github.com/simonw/covidsewage-bot/blob/bd9dcae5bcf020047955283971608507f3cd3169/.github/workflows/tweet.yml#L40-L48) that uses this tool. The repository has four repository secrets configured with the necessary credentials, and a previous step has already installed the `tweet-images` Python package: 48 | 49 | ```yaml 50 | - name: Tweet the new image 51 | env: 52 | TWITTER_CONSUMER_KEY: ${{ secrets.TWITTER_CONSUMER_KEY }} 53 | TWITTER_CONSUMER_SECRET: ${{ secrets.TWITTER_CONSUMER_SECRET }} 54 | TWITTER_ACCESS_TOKEN_KEY: ${{ secrets.TWITTER_ACCESS_TOKEN_KEY }} 55 | TWITTER_ACCESS_TOKEN_SECRET: ${{ secrets.TWITTER_ACCESS_TOKEN_SECRET }} 56 | run: |- 57 | tweet-images "Latest Covid sewage charts for the SF Bay Area" \ 58 | /tmp/covid.png --alt "Screenshot of the charts" 59 | ``` 60 | ## Development 61 | 62 | To contribute to this tool, first checkout the code. Then create a new virtual environment: 63 | 64 | cd tweet-images 65 | python -m venv venv 66 | source venv/bin/activate 67 | 68 | Now install the dependencies and test dependencies: 69 | 70 | pip install -e '.[test]' 71 | 72 | To run the tests: 73 | 74 | pytest 75 | -------------------------------------------------------------------------------- /setup.py: -------------------------------------------------------------------------------- 1 | from setuptools import setup 2 | import os 3 | 4 | VERSION = "0.1.2" 5 | 6 | 7 | def get_long_description(): 8 | with open( 9 | os.path.join(os.path.dirname(os.path.abspath(__file__)), "README.md"), 10 | encoding="utf8", 11 | ) as fp: 12 | return fp.read() 13 | 14 | 15 | setup( 16 | name="tweet-images", 17 | description="Send tweets with images from the command line", 18 | long_description=get_long_description(), 19 | long_description_content_type="text/markdown", 20 | author="Simon Willison", 21 | url="https://github.com/simonw/tweet-images", 22 | project_urls={ 23 | "Issues": "https://github.com/simonw/tweet-images/issues", 24 | "CI": "https://github.com/simonw/tweet-images/actions", 25 | "Changelog": "https://github.com/simonw/tweet-images/releases", 26 | }, 27 | license="Apache License, Version 2.0", 28 | version=VERSION, 29 | packages=["tweet_images"], 30 | entry_points=""" 31 | [console_scripts] 32 | tweet-images=tweet_images.cli:cli 33 | """, 34 | install_requires=["click", "python-twitter"], 35 | extras_require={"test": ["pytest"]}, 36 | python_requires=">=3.7", 37 | ) 38 | -------------------------------------------------------------------------------- /tests/test_tweet_images.py: -------------------------------------------------------------------------------- 1 | from click.testing import CliRunner 2 | from tweet_images.cli import cli 3 | import pytest 4 | 5 | 6 | @pytest.mark.parametrize( 7 | "options,error", 8 | ( 9 | ([], "Error: Missing argument 'TEXT'."), 10 | ( 11 | ["tweet", "file-that-does-not-exist.jpg"], 12 | "'file-that-does-not-exist.jpg': No such file or directory", 13 | ), 14 | ( 15 | ["tweet", "one.jpg", "--alt", "one", "--alt", "two"], 16 | "You passed more --alt text than you did images", 17 | ), 18 | ( 19 | ["tweet", "one.jpg", "two.jpg", "three.jpg", "four.jpg", "five.jpg"], 20 | "Pass a maximum of four images", 21 | ), 22 | ), 23 | ) 24 | def test_errors(options, error): 25 | runner = CliRunner() 26 | with runner.isolated_filesystem(): 27 | for key in ("one", "two", "three", "four", "five"): 28 | open("{}.jpg".format(key), "wb").write(key.encode("utf-8")) 29 | result = runner.invoke(cli, options) 30 | assert result.exit_code in (1, 2) 31 | assert result.output.strip().endswith(error) 32 | -------------------------------------------------------------------------------- /tweet_images/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/simonw/tweet-images/d1f0d424d9b53f3840c6980628c842dda591040c/tweet_images/__init__.py -------------------------------------------------------------------------------- /tweet_images/cli.py: -------------------------------------------------------------------------------- 1 | import click 2 | import itertools 3 | import json 4 | import twitter 5 | 6 | 7 | @click.command() 8 | @click.version_option() 9 | @click.argument("text") 10 | @click.argument("image_paths", nargs=-1, type=click.File("rb")) 11 | @click.option("alts", "--alt", help="Alt text for images", multiple=True) 12 | @click.option( 13 | "--consumer-key", envvar="TWITTER_CONSUMER_KEY", help="Twitter consumer key" 14 | ) 15 | @click.option( 16 | "--consumer-secret", 17 | envvar="TWITTER_CONSUMER_SECRET", 18 | help="Twitter consumer secret", 19 | ) 20 | @click.option( 21 | "--access-token-key", envvar="TWITTER_ACCESS_TOKEN_KEY", help="Twitter access token" 22 | ) 23 | @click.option( 24 | "--access-token-secret", 25 | envvar="TWITTER_ACCESS_TOKEN_SECRET", 26 | help="Twitter access token secret", 27 | ) 28 | def cli( 29 | text, 30 | image_paths, 31 | alts, 32 | consumer_key, 33 | consumer_secret, 34 | access_token_key, 35 | access_token_secret, 36 | ): 37 | """ 38 | Send a tweet with images 39 | 40 | Example usage:: 41 | 42 | tweet-images "Pictures of my dog!" cleo.jpg cleo-snoozing.jpg 43 | 44 | You can pass between 0 and 4 images. 45 | 46 | To specify alt text, use --alt "Alt text" - you can pass this up to four times as well. 47 | 48 | Authentication is via environment variables or --consumer-key etc options. 49 | """ 50 | if len(image_paths) > 4: 51 | raise click.ClickException("Pass a maximum of four images") 52 | if len(alts) > len(image_paths): 53 | raise click.ClickException("You passed more --alt text than you did images") 54 | 55 | # Upload the media 56 | api = twitter.Api( 57 | consumer_key=consumer_key, 58 | consumer_secret=consumer_secret, 59 | access_token_key=access_token_key, 60 | access_token_secret=access_token_secret, 61 | ) 62 | media_ids = [] 63 | for image_path, alt in itertools.zip_longest(image_paths, alts): 64 | media_id = api.UploadMediaSimple(image_path) 65 | if alt: 66 | api.PostMediaMetadata(media_id, alt) 67 | media_ids.append(media_id) 68 | 69 | # Tweet it 70 | status = api.PostUpdate(text, media=media_ids) 71 | tweet_url = "https://twitter.com/{}/status/{}".format( 72 | status.user.screen_name, status.id 73 | ) 74 | click.echo(tweet_url) 75 | --------------------------------------------------------------------------------