Skip to content
/ Brise Public

Independent TUI using OpenWeatherMap's APIs.

License

Notifications You must be signed in to change notification settings

jxmau/Brise

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

34 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Generic badge Generic badge CodeFactor

Brise

Brise-tui is a simple Terminal User Interface using OpenWeatherMap's Current Weather and Air Pollution APIs.

Resources

Dependencies and Libraries Used
  • Apache Http Component
  • Json Simple
APIs
  • Current Weather
  • Air Pollution
  • 5 Days/ 3 Hours Forecast

Disclaimer

- This TUI use OpenWeatherMap's APIs, but it is not related in any way to it.
- This TUI is for personal use only.
- Information fetched by the TUI are for indication purpose only.

Installation

Information
A release package contains three files :
  • Brise.jar -> It's literally Brise.
  • Brise.sh -> It's shell script containing a shortcut to launch Brise.
  • Readme.txt -> A txt file that will guide you to start with Brise and get infos on the version used.
First launch
1. To use Brise, open a bash window at the folder's directory, then type Brise. It's a shortcut created by the Brise.sh.
2. As Brise will now start, it will create a directory in your home directory named "Brise", and will creating in it the settings file. 3. Now that the settings file is created, you'll need to enter your OpenWeatherMap Key. 3. Brise is now ready.

If you get an error message regarding your Key that you just created, wait several minutes before trying again.

Prerequisites

OpenWeatherMap appId key

Brise-TUI uses apis from OPM accessible in the free plan.
While free, a key is required for each request from the TUI, that's why that the first time you'll launch Brise, you'll be asked to enter a key.
Don't worry if you've made a mistake, you can modify your key with the key commands listed below.

Customization

Saving a city

Brise allows you the possibility to save a city in your settings file. To save your city, you'll just need to add "-s" at the end of your command line.

System Unit

Brise supports three types of Unit System, but you can also used a personalized one by changing unit directly in the unit shell.

Unit System Speed Temperature Precipitation Air Pollution
Metric Kilometers per hour (kph) Celsius (°C) Millimeters (mm) Micrograms per cube meter(μgm3)
Metric Miles per hour (mph) Fahrenheit (°F) Inches (in) Micrograms per cube meter (μgm3)
Metric Meters per second (ms) Kelvin (°K) Millimeters (mm) Parts per million (ppm)

Commands List

Information
City Name
As one would know, a city can have a multiple words name like San Francisco or Saint Petersburg. To avoid an error, please, replace the space by a "+".
Example : New York -> New+York
State ISO code
Can be used only for US' cities.
Example : Washington US DC.

Main shell

Action Command Line Option
Quick Weather Info hello [city] [country ISO Code] [State]
Current Weather Info weather now [city] [country ISO Code] [State] -s
Today's Weather Forecast weather today [city] [country ISO Code] [State] -s
Tomorrow's Weather Forecast weather tomorrow [city] [country ISO Code] [State] -s
Current Air Pollution Info air [city] [country ISO Code] [State] -s
Current Precipitation Info rain now [city] [country ISO Code] [State] -s
Today's Precipitation Forecast rain today [city] [country ISO Code] [State] -s
Tomorrow's Precipitation Forecast rain tomorrow [city] [country ISO Code] [State] -s
Change the OWM AppId key key [your key]
View the commands' help help
Close Brise exit
Enter the settings shell settings

Help sub-commands

Action Command Line Details
To view the name of pollutants air -pollutants
To view the code colour and limits per pollutants air -limits A MD doc exists in the tools folder.

Settings shell

Action Command Line
To exit the shell exit
To change the key key
To change unit - To enter unit shell unit
Unit shell
This shell does not possess a help command, but the list and explication of the key will be shown at all time.
Action Command Line Possible choice
To change the Unit System [Unit System] metric - imperial - scientific
To change the speed's unit speed [unit] kph - mph - ms
To change the temperature's unit temperature [unit] celcius - fahrenheit - kelvin
To change the Air Pollution's unit speed [unit] μgm3 - ppm
To change the Precipitation's unit speed [unit] metric - imperial - scientific
To exit exit

License Information

This work is licensed under the Creative Commons Attribution-NonCommercial 4.0 International License. To view a copy of this license, visit http://creativecommons.org/licenses/by-nc/4.0/ or send a letter to Creative Commons, PO Box 1866, Mountain View, CA 94042, USA.



Made with ❤ and eun ch'tio peu d'crème fraiche!