[video-tweet.git] / README.md

Original repo: https://github.com/twitterdev/large-video-upload-python
Changes here are meant to be rebased.

# Large Media Upload

This Python sample demonstrates the following process of uploading large media (video / GIF / image) files asynchronously with the Twitter API, via the "chunked upload" method.

1. **INIT** media upload.
2. **APPEND** chunked data.
3. **FINALIZE** media uploaded.
4. Check **STATUS** of media processing.
5. Tweet with attached media.

Large video files are longer than 30 seconds / up to 140 seconds, and/or a file size larger than 15 megabytes up to 512 megabytes.

[Learn more](https://developer.twitter.com/en/docs/media/upload-media/overview) about the Twitter Media APIs. Pay attention to the other requirements such as encoding, frame size and video formats supported, as these may be reasons for uploads failing at the processing stage.

## Running the sample

1. Install requirements:

	```
	$ pipenv shell
	$ pipenv install
	```

2. Fill in your [consumer keys and access tokens](https://developer.twitter.com/en/apps) in `async-upload.py`:

	```
	CONSUMER_KEY = 'your-consumer-key'
	CONSUMER_SECRET = 'your-consumer-secret'
	ACCESS_TOKEN = 'your-access-token'
	ACCESS_TOKEN_SECRET = 'your-access-secret'
	```

3. Edit path to your media file in `async-upload.py`:

 ```
 VIDEO_FILENAME = 'path/to/video/file'
 ```

4. Run script:

	```
	$ python async-upload.py
	```

Questions? Check our [developer discussion forums](https://https://twittercommunity.com/c/media-apis).
Commit	Line	Data
d3ac7c48 IK	1	Original repo: https://github.com/twitterdev/large-video-upload-python
	2	Changes here are meant to be rebased.
	3
8d43f6fe	4	# Large Media Upload
97f85f28	5
8d43f6fe	6	This Python sample demonstrates the following process of uploading large media (video / GIF / image) files asynchronously with the Twitter API, via the "chunked upload" method.
97f85f28	7
	8	1. INIT media upload.
	9	2. APPEND chunked data.
	10	3. FINALIZE media uploaded.
8d43f6fe AP	11	4. Check STATUS of media processing.
8d43f6fe AP	12	5. Tweet with attached media.
97f85f28	13
8d43f6fe	14	Large video files are longer than 30 seconds / up to 140 seconds, and/or a file size larger than 15 megabytes up to 512 megabytes.
97f85f28	15
8d43f6fe	16	[Learn more](https://developer.twitter.com/en/docs/media/upload-media/overview) about the Twitter Media APIs. Pay attention to the other requirements such as encoding, frame size and video formats supported, as these may be reasons for uploads failing at the processing stage.
97f85f28	17
	18	## Running the sample
	19
	20	1. Install requirements:
	21
	22	```
8d43f6fe AP	23	$ pipenv shell
8d43f6fe AP	24	$ pipenv install
97f85f28	25	```
97f85f28	26
8d43f6fe	27	2. Fill in your [consumer keys and access tokens](https://developer.twitter.com/en/apps) in `async-upload.py`:
97f85f28	28
	29	```
	30	CONSUMER_KEY = 'your-consumer-key'
	31	CONSUMER_SECRET = 'your-consumer-secret'
	32	ACCESS_TOKEN = 'your-access-token'
	33	ACCESS_TOKEN_SECRET = 'your-access-secret'
	34	```
	35
8d43f6fe	36	3. Edit path to your media file in `async-upload.py`:
03695c65 AP	37
	38	```
	39	VIDEO_FILENAME = 'path/to/video/file'
	40	```
	41
	42	4. Run script:
97f85f28	43
	44	```
	45	$ python async-upload.py
03695c65 AP	46	```
	47
	48	Questions? Check our [developer discussion forums](https://https://twittercommunity.com/c/media-apis).