Lookout

Lookout is an upstream software respository watcher built for maintaining large collections of up-to-date applications.

Backstory

As a software maintainer, it can be a difficult and time-consuming task to keep software up-to-date. Most of us achieve this by turning on email notifications or periodically remembering to check a project's releases. However, manually checking releases isn't fool proof and email notifications can quickly become overwhelming. As a result, I wrote Lookout, a simple command line tool to store package information and to help automate the process of checking for upstream project updates.

I would like to say a big thank you to DataDrake for writing CUPPA, the upstream polling assistant library that made the development of Lookout possible.

Installation

Download Prebuilt Binaries

1. Go to Lookout Releases -->
2. Copy the link to your corresponding OS and Architecture.
3. Run sudo curl -L "PATH-TO-RELEASE-ASSET" -o /usr/local/bin/lookout
4. Run sudo chmod a+x /usr/local/bin/lookout
5. (Optional) Run sudo ln -s /usr/local/bin/lookout /usr/bin/lookout

Development Dependencies

• GCC

• Golang

• If you'd like to use lookout as an installed program you must add your go directory to your PATH.

Build

1. With go installed simply run go get github.com/alecbcs/lookout

or

1. Clone this repository and run

2. go build (This will build lookout into a binary you can add to your bin.)

3. If you've added your go bin to your system PATH you can also run go install

Usage

Commands

Examples

Commands

YAML Application Import File

name: cuppa
version: 1.1.0
source: https://github.com/DataDrake/cuppa/archive/v1.1.0.tar.gz
dependencies: 
    - golang
    - something
    - something-else

Demo

Configuration

Lookout's default configuration file is located at $HOME/.config/lookout/lookout.config

Example Config

[General]
  Version = "0.0.1"

[Database]
  Path = "$HOME/.config/lookout/apps.db"

[Github]
  Key = "GITHUB-API-KEY"

Github Config

Github limits the number of requests per day for unauthenticated clients. If you are getting a Not Found error when trying add a Github entry to lookout, you'll need to create a Github personal access key and add it to the lookout config. To get a Github key please follow the documentation on cuppa's Github page.

Thanks to ManyPixels for the amazing artwork above.

License

Copyright 2019-2021 Alec Scott hi@alecbcs.com

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.