Skip to content

Latest commit

 

History

History
196 lines (137 loc) · 11.3 KB

README.md

File metadata and controls

196 lines (137 loc) · 11.3 KB

Stargazers MIT License LinkedIn


🔎 ⏳

Google popular times

Release

A simple library for extracting popular times from a google search
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Installation
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Disclaimer

About The Project

This library is an educational proof of concept about extracting popular times from a simple Google search. It should not be used in a production ready application.

For example, if you search 'Museo del prado', you will obtain something like this:

PopularTimes(days=[Day(status=OPEN, hours=[Hour(hour=6, percent=0, message=), Hour(hour=7, percent=0, message=), Hour(hour=8, percent=0, message=), Hour(hour=9, percent=0, message=), Hour(hour=10, percent=41, message=Usually not too busy), Hour(hour=11, percent=55, message=Usually a little busy), Hour(hour=12, percent=63, message=Usually a little busy), Hour(hour=13, percent=61, message=Usually a little busy), Hour(hour=14, percent=52, message=Usually a little busy), Hour(hour=15, percent=41, message=Usually not too busy), Hour(hour=16, percent=40, message=Usually not too busy), Hour(hour=17, percent=51, message=Usually a little busy), Hour(hour=18, percent=59, message=Usually a little busy), Hour(hour=19, percent=46, message=Usually not too busy), Hour(hour=20, percent=0, message=), Hour(hour=21, percent=0, message=), Hour(hour=22, percent=0, message=), Hour(hour=23, percent=0, message=)]), Day(status=OPEN, hours=[Hour(hour=6, percent=0, message=), Hour(hour=7, percent=0, message=), Hour(hour=8, percent=0, message=), Hour(hour=9, percent=0, message=), Hour(hour=10, percent=47, message=Usually not too busy), Hour(hour=11, percent=63, message=Usually a little busy), Hour(hour=12, percent=70, message=Usually a little busy), Hour(hour=13, percent=67, message=Usually a little busy), Hour(hour=14, percent=54, message=Usually a little busy), Hour(hour=15, percent=42, message=Usually not too busy), Hour(hour=16, percent=40, message=Usually not too busy), Hour(hour=17, percent=54, message=Usually a little busy), Hour(hour=18, percent=65, message=Usually a little busy), Hour(hour=19, percent=52, message=Usually a little busy), Hour(hour=20, percent=0, message=), Hour(hour=21, percent=0, message=), Hour(hour=22, percent=0, message=), Hour(hour=23, percent=0, message=)]), Day(status=OPEN, hours=[Hour(hour=6, percent=0, message=), Hour(hour=7, percent=0, message=), Hour(hour=8, percent=0, message=), Hour(hour=9, percent=0, message=), Hour(hour=10, percent=47, message=Usually not too busy), Hour(hour=11, percent=64, message=Usually a little busy), Hour(hour=12, percent=72, message=Usually a little busy), Hour(hour=13, percent=69, message=Usually a little busy), Hour(hour=14, percent=57, message=Usually a little busy), Hour(hour=15, percent=45, message=Usually not too busy), Hour(hour=16, percent=45, message=Usually not too busy), Hour(hour=17, percent=59, message=Usually a little busy), Hour(hour=18, percent=67, message=Usually a little busy), Hour(hour=19, percent=53, message=Usually a little busy), Hour(hour=20, percent=0, message=), Hour(hour=21, percent=0, message=), Hour(hour=22, percent=0, message=), Hour(hour=23, percent=0, message=)]), Day(status=OPEN, hours=[Hour(hour=6, percent=0, message=), Hour(hour=7, percent=0, message=), Hour(hour=8, percent=0, message=), Hour(hour=9, percent=0, message=), Hour(hour=10, percent=46, message=Usually not too busy), Hour(hour=11, percent=63, message=Usually a little busy), Hour(hour=12, percent=73, message=Usually a little busy), Hour(hour=13, percent=71, message=Usually a little busy), Hour(hour=14, percent=59, message=Usually a little busy), Hour(hour=15, percent=45, message=Usually not too busy), Hour(hour=16, percent=42, message=Usually not too busy), Hour(hour=17, percent=54, message=Usually a little busy), Hour(hour=18, percent=63, message=Usually a little busy), Hour(hour=19, percent=52, message=Usually a little busy), Hour(hour=20, percent=0, message=), Hour(hour=21, percent=0, message=), Hour(hour=22, percent=0, message=), Hour(hour=23, percent=0, message=)]), Day(status=OPEN, hours=[Hour(hour=6, percent=0, message=), Hour(hour=7, percent=0, message=), Hour(hour=8, percent=0, message=), Hour(hour=9, percent=0, message=), Hour(hour=10, percent=50, message=Usually a little busy), Hour(hour=11, percent=72, message=Usually a little busy), Hour(hour=12, percent=84, message=Usually as busy as it gets), Hour(hour=13, percent=80, message=Usually as busy as it gets), Hour(hour=14, percent=64, message=Usually a little busy), Hour(hour=15, percent=49, message=Usually not too busy), Hour(hour=16, percent=49, message=Usually not too busy), Hour(hour=17, percent=61, message=Usually a little busy), Hour(hour=18, percent=66, message=Usually a little busy), Hour(hour=19, percent=51, message=Usually a little busy), Hour(hour=20, percent=0, message=), Hour(hour=21, percent=0, message=), Hour(hour=22, percent=0, message=), Hour(hour=23, percent=0, message=)]), Day(status=OPEN, hours=[Hour(hour=6, percent=0, message=), Hour(hour=7, percent=0, message=), Hour(hour=8, percent=0, message=), Hour(hour=9, percent=0, message=), Hour(hour=10, percent=42, message=Usually not too busy), Hour(hour=11, percent=74, message=Usually a little busy), Hour(hour=12, percent=98, message=Usually as busy as it gets), Hour(hour=13, percent=96, message=Usually as busy as it gets), Hour(hour=14, percent=74, message=Usually a little busy), Hour(hour=15, percent=58, message=Usually a little busy), Hour(hour=16, percent=69, message=Usually a little busy), Hour(hour=17, percent=93, message=Usually as busy as it gets), Hour(hour=18, percent=96, message=Usually as busy as it gets), Hour(hour=19, percent=66, message=Usually a little busy), Hour(hour=20, percent=0, message=), Hour(hour=21, percent=0, message=), Hour(hour=22, percent=0, message=), Hour(hour=23, percent=0, message=)]), Day(status=OPEN, hours=[Hour(hour=6, percent=0, message=), Hour(hour=7, percent=0, message=), Hour(hour=8, percent=0, message=), Hour(hour=9, percent=0, message=), Hour(hour=10, percent=41, message=Usually not too busy), Hour(hour=11, percent=77, message=Usually a little busy), Hour(hour=12, percent=100, message=Usually as busy as it gets), Hour(hour=13, percent=95, message=Usually as busy as it gets), Hour(hour=14, percent=79, message=Usually a little busy), Hour(hour=15, percent=66, message=Usually a little busy), Hour(hour=16, percent=55, message=Usually a little busy), Hour(hour=17, percent=40, message=Usually not too busy), Hour(hour=18, percent=25, message=Usually not too busy), Hour(hour=19, percent=0, message=), Hour(hour=20, percent=0, message=), Hour(hour=21, percent=0, message=), Hour(hour=22, percent=0, message=), Hour(hour=23, percent=0, message=)])])

What can the library currently extract?

  • ✅ Affluence by hour
  • ✅ Message depending the affluence (ex. Usually a little busy)
  • ✅ Status (open or closed) by hour

What it doesn't do

  • ❌ Extract business hours

Built With

Installation

To get a copy up and running follow these simple steps. You can find the latest version here or at Jitpack.

Maven

  • Add this snippet to the 'dependencies' section in your pom.xml:
<dependency>
	    <groupId>com.github.juanaviladev</groupId>
	    <artifactId>google-popular-times</artifactId>
	    <version>latest-version-here</version>
</dependency>

Also, this one into the 'repositories' section:

<repository>
  <id>jitpack.io</id>
  <url>https://jitpack.io</url>
</repository>

Gradle

  • Add it in your root build.gradle at the end of repositories:
allprojects {
		repositories {
			...
			maven { url 'https://jitpack.io' }
		}
	}

Also, add the dependency:

dependencies {
  implementation 'com.github.juanaviladev:google-popular-times:latest-version'
}

Usage

Please visit example module to see a fully working example.

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

  1. Fork the Project
  2. Create your Feature Branch from master (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Disclaimer

This library has been made to be used for educational purposes, please read Google TOS before using it for any other purpose