https://github.com/alan-turing-institute/whatwhat
A reimagining of nowwhat in OCaml
Science Score: 36.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
○CITATION.cff file
-
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
○DOI references
-
○Academic publication links
-
✓Committers with academic emails
5 of 8 committers (62.5%) from academic institutions -
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (13.3%) to scientific vocabulary
Keywords
Repository
A reimagining of nowwhat in OCaml
Basic Info
- Host: GitHub
- Owner: alan-turing-institute
- License: mit
- Language: OCaml
- Default Branch: main
- Homepage: https://alan-turing-institute.github.io/whatwhat/
- Size: 1.59 MB
Statistics
- Stars: 0
- Watchers: 9
- Forks: 0
- Open Issues: 19
- Releases: 16
Topics
Metadata Files
README.md
WhatWhat
whatwhat is an OCaml command-line tool to help monitor project status and allocations in the Research Engineering Group, aka Hut23.
Install
whatwhat is available via Homebrew:
sh
brew update
brew tap alan-turing-institute/hut23
brew install alan-turing-institute/hut23/whatwhat
Once installation is complete, run whatwhat init.
This will set up some configuration files in ~/.config/whatwhat.
You will now have to edit them to add your personal tokens, as described below.
Configure
In ~/.config/whatwhat/secrets.json, you should see the following JSON template:
```json
{
"githubToken" : "
// other stuff can be ignored
} ```
githubToken can be obtained from https://github.com/settings/tokens.
Note that you have to use the "classic" tokens, not the "fine-grained, repo-scoped" tokens.
The token will need to have the permissions: read:user, repo, and user:email.
forecastToken can be obtained from https://id.getharvest.com/oauth2/access_tokens/new.
The other fields in this file can be ignored.
Extra: creating a lookup table for GitHub usernames
`whatwhat` attempts to match people's full names on Forecast with GitHub usernames using some heuristics. It is generally quite successful at doing this, but there are a few edge cases where people's GitHub profiles do not have enough data. To see what `whatwhat`'s automatic username detection is doing, you can run `whatwhat dump-users`. If you find that the automatic detection for a person is wrong or missing, you can override it by manually add a mapping inside the file `~/.config/whatwhat/users`. Each line in this file should look like: {Full name on Forecast}:{GitHub username} (without the curly braces).Usage
Once you have added the two tokens, you should be able to run whatwhat from the command line.
The main commands you are likely to use are shown here.
For extensive usage options, you can run whatwhat --help, or whatwhat <subcommand> --help.
| Command | Description |
| ------ | ----------- |
| whatwhat | Fetch all projects, detecting inconsistencies and errors |
| whatwhat project [NUM\|NAME] | Print information about a project, as specified by its GitHub issue number, or (a substring of) its title |
| whatwhat person [NAME] | Print information about a person, as specified by their name, Turing email username, or GitHub username (a substring is fine) |
| whatwhat overview | Print a TL;DR of what's happening in REG |
| whatwhat export-project | Create a Forecast project export CSV file (useful for other reporting purposes) |
| whatwhat export-team | Create a Forecast team export CSV file |
| whatwhat open [NUM] | Open a GitHub issue in a browser (macOS only, as this uses open(1)) |
A historical note
Whatwhat is the successor to NowWhat (F#) and WhatNow (Racket).
The latter contains an illuminating backbrief describing the history of project allocations in REG.
Developer notes
See CONTRIBUTING.md for information on how to contribute to whatwhat.
Owner
- Name: The Alan Turing Institute
- Login: alan-turing-institute
- Kind: organization
- Email: info@turing.ac.uk
- Website: https://turing.ac.uk
- Repositories: 477
- Profile: https://github.com/alan-turing-institute
The UK's national institute for data science and artificial intelligence.
GitHub Events
Total
- Create event: 4
- Release event: 2
- Issues event: 9
- Delete event: 2
- Issue comment event: 10
- Push event: 23
- Pull request event: 1
Last Year
- Create event: 4
- Release event: 2
- Issues event: 9
- Delete event: 2
- Issue comment event: 10
- Push event: 23
- Pull request event: 1
Committers
Last synced: about 1 year ago
Top Committers
| Name | Commits | |
|---|---|---|
| Jonathan Yong | y****e@g****m | 226 |
| Markus Hauru | m****u@t****k | 69 |
| = | j****s@t****k | 43 |
| KatrionaGoldmann | k****n@t****k | 35 |
| Penelope Yong | p****m@g****m | 29 |
| David Salvador Jasin | d****n@t****k | 24 |
| callummole | c****e@t****k | 16 |
| Isabel Fenton | I****n | 15 |
Committer Domains (Top 20 + Academic)
Issues and Pull Requests
Last synced: 11 months ago
All Time
- Total issues: 80
- Total pull requests: 31
- Average time to close issues: 3 months
- Average time to close pull requests: 2 months
- Total issue authors: 7
- Total pull request authors: 5
- Average comments per issue: 1.6
- Average comments per pull request: 0.26
- Merged pull requests: 29
- Bot issues: 0
- Bot pull requests: 0
Past Year
- Issues: 5
- Pull requests: 0
- Average time to close issues: N/A
- Average time to close pull requests: N/A
- Issue authors: 2
- Pull request authors: 0
- Average comments per issue: 0.6
- Average comments per pull request: 0
- Merged pull requests: 0
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
- triangle-man (28)
- yongrenjie (26)
- mhauru (7)
- KatrionaGoldmann (4)
- callummole (4)
- jemrobinson (4)
- penelopeysm (4)
Pull Request Authors
- mhauru (12)
- callummole (6)
- triangle-man (6)
- yongrenjie (5)
- KatrionaGoldmann (2)