Skip to content

Latest commit

 

History

History
179 lines (116 loc) · 6.19 KB

README.md

File metadata and controls

179 lines (116 loc) · 6.19 KB

Console Weather App | Tweet

GitHub commit activity GitHub commits since latest release GitHub last commit (by committer) GitHub Downloads (all assets, all releases) Build and Release GitHub closed issues GitHub code size in bytes

Live Viewers

Viewers


Console Weather Logo subject to copyright. © Degamisu, Emi Yamashita.

About

This app is a console-based weather app. You can choose between 2 options for location. You can Specify the location, or you can automatically find the location based off of GPS tracking. This is a very fast and reliable service that is being updated frequently.

Important Information

The Legacy version of CWA is available here. It has the following:

  • Stable application
  • Normal integrated print() functions
  • Accurate weather statements
  • There is no city select. You will get an error: City Select is not implemented yet, CWA will now quit
  • There is no autoinstall. You will have to build/run this manually

This app contains a secret code to function properly. In some parts of the code, a variable named {GH_TOKEN} is created. However, if you use Codespaces, you must provide your own secret code for the scripts to work. (eg, build_and_release.yml - Github Actions)


There is a wiki! you can find this in the wiki tab. The tab includes:

  • Directory Graph
  • Error Codes
  • Information
  • Dependencies

Security

Note

For more details in security, go to SECURITY

Privacy is a top concern for users, especially when it comes to applications that involve location tracking. Rest assured, the Console Weather App prioritizes user privacy and follows these principles:

  • No Personal Information Collection: The app does not collect any personal information or location data beyond what is necessary for gathering weather information.

  • Local Console Usage: Your location is used solely within the console environment to fetch real-time weather data. It is not transmitted or stored externally.

  • Broad Location Data: The app only accesses broad location information, ensuring that no specific details are leaked.

It's important to note that the safety of the app depends on its usage and commitment to the official repository. If you ever fork the project, please review the code to ensure its safety.

Still unsure? You may check the code for yourself. Any comments and concerns can be in the Discussions tab or Issues tab. Any vulnerabilities that arise may go into the Issues tab.

Sources

This app gets its weather data with:

Making this app very fast and reliable.

Installation (with source AutoInstall)

To make it easier to build, I created a script that does all the building for you. The file is called AutoInstall. This makes the build process faster, but there are a few disadvantages

  • Deletes the Build process source code (generated automatically)
  • One set path.

Installation (with source)

Note

  • This currently only works on Ubuntu Linux. This may change.
  • Git must be installed. Install it with this
  • This is good if you want to keep the build artifacts and mess with a few files.
Download Source Code

To install the source code, run this command in any terminal:

mkdir Console-Weather-App-Source && cd Console-Weather-App-Source && gh repo clone Degamisu/Console-Weather-App && cd Console-Weather-App

This should download the source

Install Dependencies This is the install command to install necissary dependencies.
pip install -r requirements.txt

THIS IS CRUCIAL to the installation of CWA.


The next part can be done in 2 ways

Build the executable

This requires pyinstaller to build, which is installed under the Install Dependencies dropdown


To build, run this into your bash console

pyinstaller --onefile main.py
Run directly This is the easiest way through, skipping the building part. However, it would be harder to transport.

Python

cd dist && python main.py

Python3

cd dist && python3 ./main.py

This section is optional.

Cleanup

To clean up build artifacts (under /build), run this script:

rm -r build

Contributing

Have an idea for CWA? Contributing will be open soon. For now, you can open issues!


Additions

Filename Added
SECURITY.md ✔️
CONTRIBUTING.md
README.md ✔️
LICENCE.md ✔️
CODE_OF_CONDUCT.md ✔️

Is this readme missing something? If so, shoot a pull request! I will review it ASAP!

© 2024 Degamisu | All Rights Reserved | README Created by Emi Yamashita