cjustacoder / ec601-mini-project-1

This repository is the work place of mini pojects 1 in EC601

work-for-EC601

Let's make the most simple instruction in case of that I'm running out of time.

If you want to check my MiniProject3, please switch to branch---miniproject3

How to run this project

1. First you should create a folder and download all the files in this project into this folder(video may not be necessary);
2. Put your Google cloud credential(the json file) into this this folder;
3. Creat a text file in this folder and copy your twitter credential into this file make sure that you paste your keys and token with the following format(without quote):

(API key)
(API secret key)
(Access token)
(Access token secret)

make sure that you copy and paste, only paste your those four strings to each line as the same order as mentioned, without anything else, including space;

4. Edit 'start_here.bat', replace the content behide "=" by your google credential file name, without space, as following;

set GOOGLE_APPLICATION_CREDENTIALS=My Project 27058-f61d3c8b09ce.json

5. Edit 'myprojectcode.py', go to the line 280, replace the name of twitter credential file(created in step.3) by yours;
6. Create an empty folder named "images" in the current folder;
7. To start the whole program, run the 'start_here.bat';
8. You may enter any argument you want when system ask you, but to test the project better and make sure it works, I suggest that you can always press the "Enter"key to use my default value, and it will also be easier for you to test my code;
9. If you want to run my project more than once, please delete all the files in folder "images"
10. I will show you the result and the process of running my code, so if there is any problem with my code, please send Issues to me, thanks.

ec601-mini-project-1's Issues

test

nnnnnnnnnnnn

Code Review

Hi Zhongyuan Cai,
First Congratulations on what you have done for this mini project, it's truly a marvelous job!
Here are my suggestions came to my mind when I read and run your code:

1. When I followed your readme.md and created a text with my twitter key in it, I input my keys in the brackets without deleting them by accident, which no doubt cause a fault, but there is no warning or reminder for this mistake in the code, I think maybe it is better to add one? Morever, maybe an instruction for naming the text file to "twitter_api.txt" is needed, instead of changing it to the name the user made in line 300:

twitter_content = get_all_tweets(name, 'twitter_api.txt')

or maybe you could add a line of code to help the user to rename the file, just an advice.

2. The code went well when I use the default input, but when I input other username, there is a failure shown on the screen, and I can't tell by the warning that what lead to the failure, does the user have no timeline or something else? Maybe it is better to make it clear.

3. The whole project is in one python file, although you did a great job on making comments on your code, still it is not a easy thing to read or debug when facing your 300s lines of code, maybe you could simply seperate them to different parts based on different functions and process of the project?

Again, you surly did a good job!
Xiang Li