rorybyrne / glance

A tool to summarize useful information about your code repositories

Glance

When a project spans multiple repositories, it can be hard to keep track of the status and activity of the whole thing. A full dashboard is probably overkill, so this tool gives lightning-fast, summarized view of what's going on across multiple repositories - a glance.

Project Status

This project has just begun.

If you have ideas for design, architecture, or implementation, please join the discussions in the relevant issues and make your voice heard. If you want to contribute to the project please star/watch the repository to get notifications when new issues are added.

glance's Issues

The repository should have a LICENCE file

Perhaps an MIT licence?

The tool should be able to naively authenticate against Github

Current Situation

There is no authentication implemented.

Enhancement

The tool should be able to communicate with the Github API via authenticated requests.

Reasoning

The tool must be able to access private repositories.

Implementation

This can be built into the git/ directory as a method on the Github class.

Tasks

• ???

The renderer should be able to render a series of components in a grid structure

Enhancement

When summarizing meta-info for more than one repository (which is the point of this tool), it will be necessary to display each repository's information separately. A grid structure could work, with N rows of M columns.

This is like what can be seen in the README image.

Reasoning

We'd like to display the summary for each repository in a nice structure via the CLI.

Implementation

It looks like Rich has the concept of columns, so perhaps we can use this.

Tasks

• ???

Purpose, scope, and approach

What problem or problems is this tool trying to solve?

Which problems are in-scope, and which are clearly not appropriate for this tool to attempt to solve?

At a high-level, how can we go about solving those problems?

The repository should have a CONTRIBUTING.md file

The file should explain how the project is run so that it's easy to get involved.

Choice of technology

This is fairly self-explanatory.

Specifically, decisions need to be made on:

• Language choice
• CLI input parser
• CLI UI renderer
• Should YAML be the format-of-choice for representing a "view"
• ???

The renderer should be able to display a box containing information about a specific repository

Enhancement

The box should look something like the README image.

The title should of course be the repository's name. The content below that could be defined by a view.yaml file perhaps.

Reasoning

It's a standard unit of rendering, I suppose.

Implementation

Rich seems to have boxes in the columns example.

Tasks

• ???

The tool should be able to list the branches of a repository matching a given regex pattern

Enhancement

A simple command like glance run --repo XYZ --branch-pattern "release-*" should return a list of branches matching the pattern.

Reasoning

This is the MVP of multi-repo visibility.

Implementation

To do this, we'll need:

• A Github API wrapper implementation in git/
• A simple view in views/
• A command in cli/
• A naive_list component in render

Tasks

• Write an API wrapper to fetch the branches of a given repository
• Create a naive_list component to render the branches
• Create a view to orchestrate the operation
• Create a CLI command to act as the entrypoint

The repository should have a pyproject.toml for installation

It should include a command-line entrypoint for the CLI.

Components and architecture

It's hard to suggest an architecture before we've nailed down exactly what problem the tool is trying to solve.

Some assumptions about what the components and architecture will need to achieve:

• Glance should in some way aggregate information from multiple repositories
• Glance needs to infer some facts about the topology of the repositories (e.g. branch naming schemes)
• Glance needs to know which aggregations are valuable to the user. Perhaps the user can specify this via the CLI.