Code Monkey home page Code Monkey logo

check-alert's Introduction

logo

Check Alert


This project makes use of Holberton School's Checker API.

The checker is a utility that runs a student's code against a test suite. It makes sure their code functions properly and even tests for edge cases.

the checker

However, it is not immediately available to students when a new project is released. Sometimes it is withheld until an unspecified time to let students try to write functioning code without the additional assistance that the checker provides.

Wouldn't it be nice to know when the checker becomes available though? Some kind of an alert that lets you know you can check the code you've written? Check Alert uses Holberton's checker API to alert students when the checker is released. The alert is then sent to a Slack channel of their choice.

Occasionally a project does not have a checker. This may be because there needs to be a manual review by a human instead of an automatic review. In this case, Check Alert will let the student know that there will not be a checker for the specified project.


How does it work?

First you'll need to git clone this repository so you have the script. Please enter the following command:

git clone https://github.com/nokeefe/Check-Alert.git

When you run the script, you'll be met with a series of prompts that are necessary to make sure the correct project is being accessed. Here are the list of prompts you'll need to enter:

  • Your API key from the 'My Tools' section of your Holberton profile. Click the link and scroll to the bottom of the page.

  • Your Holberton School ID number.

  • Your Holberton School password (we do not store this password anywehre).

  • The project ID, which can be found next to the project title on the project list page.

    project_id

  • URL for Slack channel to send alert to. Please visit the Slack webhook website to find this URL

    webhook


Demo of Usage

Check-Alert$ ./check_alert.py

Visit: https://intranet.hbtn.io/dashboards/my_tools
and enter your API key from the bottom of the page:
<Your API key>

Enter your Holberton ID:
<Your Holberton ID>

Enter your Holberton password. (We do not store it)
<Your Holberton password>

Which project? (ID at the end of the project's URL)
<The project ID>

Please visit https://checkalert.slack.com/apps/new/A0F7XDUAZ-incoming-webhooks
Select a channel and paste the link here:
<Long link>

About

This project was created by:

check-alert's People

Contributors

rmolimock avatar mcavigli avatar vdphan avatar dwkwan avatar

Stargazers

stephen kimani - DANKA avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.