Skip to content

A checker for Holberton School that render the results and send a picture to a Twitter account

Notifications You must be signed in to change notification settings

Danucas/finally_did_it

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

19 Commits
 
 
 
 
 
 
 
 

Repository files navigation

Finally Did it

A simple tool for checking your Project Tasks, and post the checker result to your Twitter account with a customizable message.

Requirements

  • Holberton API key
  • Holberton email
  • Intranet Password
  • Twitter access credentials (create a developer account and an app) docs

Environment

  • Ubuntu 18.04.4
  • Python required 3.6 or higher follow steps 5 & 6 then use update alternatives to set python3.6 as higher priority
  • Django 3.0 + -> will be installed by the script please be sure of using pip for python3.6 as default

Install Django and required modules for Development purpose

The installation script covers the mayority of dependency installations, if the environment fail please let me know via email [email protected] by now, I will take care of your need and try to solve the issue.

Install all dependencies and modules

./install.sh

go to the checker_publisher directory and run

./refresh_publisher.sh       # This will run migrations functions and will
                             prompt you to create an admin user

# And then
./run_publisher.sh           # This will run the server at <localhost:8000/dashboard>

Route

/dashboard

This is the main route, via queries will interact with the django ORM engine to provide data reliablity, session management, and social media communication.

you will provide your Holberton API key, your holberton email and intranet password, this data will be stored locally in your machine and will help the api services to make the requests needed. When done with Authentication you will be able to search a project by its id, choose in a list of tasks and run a test for that dutty, then when you are success with the task, you can choose send a customized message via Twitter, to be able to do that you will be promt to save your Twitter app credentials, when submited the checker image will be sent with you message and you will receive the link to the published history

ScreenShots

Login section

The login will ask for your Holberton credentials, send a request to the intranets API and then stores the auth_token locally in the sessionStorage at the browser you can check this value in devtools, this way the transactions will only use your token to access the data store in the project db, the social media credentials storing is improving right now so the experience flow will be more user friendly and easy to use

Login All screenshots

Storage

  • sqlite3

Models

Channel

This model stores the credentials needed to social media posting

JSON example:

{
	'api_key': self.api_key,
	'api_secret': self.api_secret,
	'token': self.token,
	'token_secret': self.token_secret,
	'email': self.email -> this will allow us to filter by each user
}

Sended

This models stores historic sended messages simple model

{
	'channel': self.channel,
	'status_id': self.status_id,
	'user_name': self.user_name,
	'user_screen_name': self.user_screen_name,
	'content': self.content,
	'img_url': self.img_url,
	'checker_url': self.checker_url,
	'date': self.date,
	'email': self.email -> this will allow us to filter by each user
}

About

A checker for Holberton School that render the results and send a picture to a Twitter account

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published