https://github.com/mallozup/blacktango
console client for software maintainers
https://github.com/mallozup/blacktango
api-client elixir erlang functional-programming github graphql
Last synced: 7 months ago
JSON representation
console client for software maintainers
- Host: GitHub
- URL: https://github.com/mallozup/blacktango
- Owner: MalloZup
- Created: 2019-03-12T22:49:59.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2019-03-30T12:01:52.000Z (over 6 years ago)
- Last Synced: 2024-10-30T08:36:49.290Z (12 months ago)
- Topics: api-client, elixir, erlang, functional-programming, github, graphql
- Language: Elixir
- Homepage:
- Size: 12.7 KB
- Stars: 3
- Watchers: 3
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Blacktango
Interactive, minimalistic CLI for interacting with various APIs outside in the world.
For `software` mantainers which want to keep opensource projects healthy.
# Quickstart:
#### Erlang/Elixir instal:
Follow the upstream doc for installing `elixir/erlang`.
https://elixir-lang.org/install.html
1) clone this repo and ensure you have `elixir` installed.
2) On cloned repo create `.github_ops.yaml` file with content
```yaml
---
token: "your_TOKEN"
github_repos: ["MalloZup/kubeojo", "MalloZup/blacktango", "MalloZup/bacheca"]
# used by Github.comment_prs_and_issues
tolleration_days: 30
```
Define a list of GitHub repos where you want to perform actions.
- `tolleration_days` is positive number see API `Github.comment_prs_and_issues`
3) run `iex -S mix` for launching the console
Now let's look at `Blacktango API` calls.
## Blacktango API/Usage:
Assuming you are in console mode, see step 3 of quickstart, type in your terminal
`Github.comment_prs_and_issues`
What does this command do?
On a high-level perspective it will help to keep projects healthy, reminding people on older issues or PR with a gently comment on GitHub PR/ISSUE, if they are working on it.
It ill write a comment on GitHub Pull-requests and Issues, reminding that the issue is older then the 30 days. ( You can make the value bigger or smaller see `tolleration_days:`)
`example`: if you have 4 project with 4000 issues older then 30 days, blacktango will automatically leave a comment on the issue that say that the issue is older then 30/more days, and maybe it should be closed
here is a live example: ( data is faked but you will have this)
```elixir
iex(2)> Github.comment_prs_and_issues
checking Issues
adding comment to GitHub Issue https://github.com/MalloZup/il-bar-bro/issues/740
checking Pull-Requests
adding comment to GitHub PR https://github.com/MalloZup/tania/pull/705
adding comment to GitHub PR https://github.com/MalloZup/gino/pull/719
```
# Goals and roadmap:
## version 0.0.2
Feel free to spend an issue if you have ideas.
- add milestone check:
Write a comment for issues with a milestones that has expired.
- investigate on graphql 100 issue
# API: Currently supported:
- (GitHub API v4 `graphql`).