leereilly/swot

Swot :apple:

📦 Archive notice:

What started as a tiny helper script to verify student email domains quietly grew into a hugely impactful project. SWOT scaled into the backbone of GitHub Education’s student verification system - powering automatic access to free private repositories, unlocking the Student Developer Pack, and quite literally delighting millions of students around the world.

Along the way, it saved maintainers and GitHub staff not just hours, but hundreds of thousands (if not bazillions) of hours in manual review. A simple idea became a global gateway into the developer ecosystem - helping an entire generation of students start coding with professional-grade tools, for free.

This repo is now archived, but the work lives on. The incredible team at JetBrains is carrying the torch - follow their fork for future updates: JetBrains/swot.

To everyone who submitted domains, PRs, and issues over the years: thank you. You helped shape a project that made open source education more accessible, and the impact will outlive this repository. 🙏

Cheers,
Lee 🍻

If you have a product or service and offer academic discounts, there's a good chance there's some manual component to the approval process. Perhaps .edu email addresses are automatically approved because, for the most part at least, they're associated with American post-secondary educational institutions. Perhaps .ac.uk email addresses are automatically approved because they're guaranteed to belong to British universities and colleges. Unfortunately, not every country has an education-specific TLD (Top Level Domain) and plenty of schools use .com or .net.

Swot is a community-driven or crowdsourced library for verifying that domain names and email addresses are tied to a legitimate university of college - more specifically, an academic institution providing higher education in tertiary, quaternary or any other kind of post-secondary education in any country in the world.

Pop quiz: Which of the following domain names should be eligible for an academic discount? stanford.edu, america.edu, duep.edu, gla.ac.uk, unizar.es, usask.ca, hil.no, unze.ba, fu-berlin.de, ecla.de, bvb.de, lsmu.com. Answers at the foot of the page.

Installation

Swot is a Ruby gem, so you'll need a little Ruby-fu to get it working. Simply

gem install swot

Or add this to your Gemfile before doing a bundle install:

gem 'swot'

Requirements

• Ruby >= 2.0

Usage

Verify Email Addresses

Swot::is_academic? '[email protected]'           # true
Swot::is_academic? '[email protected]'           # true
Swot::is_academic? '[email protected]'  # true
Swot::is_academic? '[email protected]'                   # true
Swot::is_academic? '[email protected]'                 # true
Swot::is_academic? '[email protected]'               # false

Verify Domain Names

Swot::is_academic? 'harvard.edu'              # true
Swot::is_academic? 'www.harvard.edu'          # true
Swot::is_academic? 'http://www.harvard.edu'   # true
Swot::is_academic? 'http://www.github.com'    # false
Swot::is_academic? 'http://www.rangers.co.uk' # false

Find School Names

Swot::school_name '[email protected]'
# => "University of Strathclyde"

Swot::school_name 'http://www.stanford.edu'
# => "Stanford University"

Contributing to Swot

Contributions welcome! Please see the contribution guidelines for details on how to add, update, or delete schools. Code contributions and ports to different languages welcome too.

Thanks to the following people for their contributions: @blutack, @captn3m0, @chrishunt, @johndbritton, @johnotander, @pborreli, @rcurtis, @vikhyat,.

Special thanks to @weppos for the public_suffix gem :metal:

Known Issues

• You can search by email and domain names only. You cannot search by IP.
• You don't know if the email address belongs to a student, faculty, staff member, alumni, or a contractor.
• There may be a few false positives, missing institutions... maybe even a couple of typos. Contributions welcome!

Please note: just because someone has verified that they own [email protected] does not mean that they're a student. They could be faculty, staff, alumnni, or maybe even an external contractor. If you're suddenly getting a lot of traffic from websites like FatWallet or SlickDeals, you might want to find out why. If you're suddenly getting a lot of requests from a particular school, you should look into that too. It may be good business, word of mouth, or someone may have found a loophole. Swot gives you a high confidence level - not a guarantee. I recommend putting some controls in place or at least monitor how it's doing from time to time.

What is a swot?

According to UrbanDictionary :blue_book:

A word used by morons to insult a person of superior academic abilities.

or

[verb] To Swot; Revision undertaken preceding an examination.

or

[backronym] Stupid Waste of Time

Pop Quiz Answers

Hopefully, you'll be surprised by some of this:

If you verified this by visiting all of the websites, how long did it take you? Did you have fun? Imagine you had to do this 10 - 100 times every day. Now you know a little something about the inspiration for Swot. Swot can verify them all in a fraction of a second and remove a :poop: part of someone's job.

See Also

• gman - like swot, but for government emails
• swotphp - PHP port of Swot
• swot-js - JS port of Swot
• swot-simple - JS port of Swot
• swot-clj - Clojure port of Swot
• swot - Go port of Swot