quetzpy 0.1.0

Analyze how people are talking about any topic on Twitter.

Quetzalcoatl :snake: :bird: :eyeglasses:

Understand how people are talking of a topic based on a simple query

• Quetzalcoatl :snake: :bird: :eyeglasses:
  • 1. WHAT IS IT?
  • 2. WHAT'S INSIDE THIS REPO ?
    • 2.1 root folder
    • 2.2 src folder
    • 2.3 __config__ folder
    • 2.4 media folder
  • 3. HOW TO USE IT ?
  • 4. ABOUT THE PROJECT
  • 5. CONTACT THE AUTHOR
  • 6. CONTRIBUTE

1. WHAT IS IT?

The Queztzalcoatl project is the ability to :eyes: excavate the :bird: Twitter API to extract insights about any topic that people talk about.
From a topic, you should be able to understand how people react using the power of text mining.

:arrow_up: Go to top page

2. WHAT'S INSIDE THIS REPO ?

Quetzalcoatl
├── /__config__
│   ├── DEMO_configuration_extractor.json
│   └── DEMO_configuration_runner.json
├── /media
├── /src
│   ├── /modules
│   │   ├── data_cleaning.py  
│   │   ├── data_mining.py  
│   │   ├── data_stats.py  
│   │   ├── decorators.py  
│   │   └── tweeter_connection.py  
│   └── Quetzalcoatl.py
├── requirements.txt
├── demo.py
├── .gitignore  
├── README.md
└── LICENCE

2.1 root folder

You will find:

File	Description
requirements.txt	Used by pip to install dependancies
demo.py	A demo script
.gitignore	-
README.md	-
LICENCE	-

2.2 src folder

You will find:

File	Description
/src/modules	Contains modules used by the project
/src/modules/data_cleaning.py	module used to clean the tweets
/src/modules/data_mining.py	module used to extract insights from each tweets
/src/modules/data_stats.py	module used to run some statistics from the mined data or tracked words
/src/modules/decorators.py	module that contains all the decorators
/src/modules/tweeter_connection.py	module used to connect to the Twitter API
/src/Quetzalcoatl.py	Contains all the classes of the project

2.3 __config__ folder

You will find the two configuration files used by the demo script

2.4 media folder

All the stuff that are used to produce documents

:arrow_up: Go to top page

3. HOW TO USE IT ?

Want to try the project? Please, follow the instructions from the Wiki page!

:arrow_up: Go to top page

4. ABOUT THE PROJECT

I started this project a long time ago as my very first Python project. At first, I used some webscraping with Selenium as I didn't know how to use an API. As my experience with Python grew, I switched to the Twitter REST API and bash scripting and started think automation. Now, I am willing to create a package, or even an API inside which it would be possible to track an information inside a topic.

:arrow_up: Go to top page

5. CONTACT THE AUTHOR

You can reach me on Twitter {LINK}
I am also on LinkedIn {LINK}

6. CONTRIBUTE

The Quetzalcoatl is a open source project. As so, if you feel interested in building the project with me, it would be amazing!
Feel free to contact me on Twitter so I can tell you how you can help.
We also have an issue page, link here!

:arrow_up: Go to top page