first set of updates (close #5, #7) (#9)

diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md
new file mode 100644 (file)
index 0000000..ef3b9bc
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE.md
@@ -0,0 +1,13 @@
+One line summary of the issue here.
+
+### Expected behavior
+
+As concisely as possible, describe the expected behavior.
+
+### Actual behavior
+
+As concisely as possible, describe the observed behavior.
+
+### Steps to reproduce the behavior
+
+Please list all relevant steps to reproduce the observed behavior.
\ No newline at end of file

diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
new file mode 100644 (file)
index 0000000..2efee8f
--- /dev/null
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,15 @@
+### Problem
+
+Explain the context and why you're making that change.  What is the
+problem you're trying to solve? In some cases there is not a problem
+and this can be thought of being the motivation for your change.
+
+### Solution
+
+Describe the modifications you've done.
+
+### Result
+
+What will change as a result of your pull request? Note that sometimes
+this section is unnecessary because it is self-explanatory based on
+the solution.
\ No newline at end of file

diff --git a/.gitignore b/.gitignore
index 0ad7621b8e0204f9a76c923ced5d4bcc26d8f61d..d92e9e3c2854f2a6a9acb0c33fa3d17bbf8d8293 100644 (file)
--- a/.gitignore
+++ b/.gitignore
@@ -23,6 +23,7 @@ var/
 *.egg-info/
 .installed.cfg
 *.egg
+*.lock
 
 # PyInstaller
 #  Usually these files are written by a python script from a template
@@ -90,3 +91,5 @@ ENV/
 
 
 .DS_Store
+
+.vscode/
\ No newline at end of file

diff --git a/LICENSE b/LICENSE
index 4cd78c6a47179b26dbb31d0fcf8bd078a736814f..de97bd36ab5e1db59c3fa6fa1ce5cb58c28f7925 100644 (file)
--- a/LICENSE
+++ b/LICENSE
@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2016 @TwitterDev
+Copyright (c) 2016- @TwitterDev
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

diff --git a/Pipfile b/Pipfile
new file mode 100644 (file)
index 0000000..0fc1534
--- /dev/null
+++ b/Pipfile
@@ -0,0 +1,14 @@
+[[source]]
+url = "https://pypi.org/simple"
+verify_ssl = true
+name = "pypi"
+
+[packages]
+oauthlib = "*"
+requests = "*"
+requests-oauthlib = "*"
+
+[dev-packages]
+
+[requires]
+python_version = "3.7"

diff --git a/README.md b/README.md
index 643537a6f2bf66d84831ab3c8317fbd64fccd06c..1a4354133a2ba71a0b3e8a046acc3ada774162e5 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,26 +1,27 @@
-# Large Video Upload
+# Large Media Upload
 
-This Python sample demonstrates the following process of uploading large video files asynchronously with the Twitter API.
+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 video processing.
-5. Tweet with attached video.
+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.
+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://dev.twitter.com/rest/media) about the Twitter Media APIs. Pay attention to the other requirements such as encoding, frame size and video formats supported.
+[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:
 
        ```
-       $ pip install -r requirements.txt
+       $ pipenv shell
+       $ pipenv install
        ```
 
-2. Fill in your [consumer keys and access tokens](https://apps.twitter.com) in `async-upload.py`:
+2. Fill in your [consumer keys and access tokens](https://developer.twitter.com/en/apps) in `async-upload.py`:
 
        ```
        CONSUMER_KEY = 'your-consumer-key'
@@ -29,7 +30,7 @@ Large video files are longer than 30 seconds up to 140 seconds, and/or a file si
        ACCESS_TOKEN_SECRET = 'your-access-secret'
        ```
 
-3. Edit path to your video file in `async-upload.py`:
+3. Edit path to your media file in `async-upload.py`:
 
  ```
  VIDEO_FILENAME = 'path/to/video/file'

diff --git a/requirements.txt b/requirements.txt
deleted file mode 100644 (file)
index a8e58d7..0000000
--- a/requirements.txt
+++ /dev/null
@@ -1,3 +0,0 @@
-oauthlib==1.1.2
-requests==2.10.0
-requests-oauthlib==0.6.1