gfas-api 0.4.0

Sync GitHub followings to followers
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98

# gfas

gfas (**G**itHub **F**ollowing **A**uto **S**ynchronization) manipulates your
GitHub following list to match your followers, enabling you to follow back
and unfollow back automatically. It runs on CLI and can be scheduled with
[GitHub Actions](https://docs.github.com/actions).

[![GitHub Actions](https://img.shields.io/github/actions/workflow/status/jwcub/gfas/ci.yml?style=flat-square)](https://github.com/jwcub/gfas/actions)
[![Coverage](https://img.shields.io/codecov/c/github/jwcub/gfas?token=W3H6GBVQZW&style=flat-square
)](https://app.codecov.io/github/jwcub/gfas)
[![Crates.io](https://img.shields.io/crates/v/gfas-cli?style=flat-square)](https://crates.io/crates/gfas-cli)
[![Downloads](https://img.shields.io/crates/d/gfas-cli?style=flat-square)](https://crates.io/crates/gfas-cli)
[![License](https://img.shields.io/github/license/jwcub/gfas?style=flat-square)](LICENSE)

## Usage

### GitHub Actions

- Copy-paste the
[Sync](.github/workflows/sync.yml)
workflow to any of your repositories. You can just fork this repository for convenience.
- Create a
[personal access token](https://docs.github.com/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens)
with the `user:follow` permission.
- Create an
[secret](https://docs.github.com/actions/security-for-github-actions/security-guides/using-secrets-in-github-actions)
named `TOKEN` in the repository containing the token value.
- Customize your workflow, e.g. modify the [scheduled time](https://docs.github.com/actions/writing-workflows/choosing-when-your-workflow-runs/events-that-trigger-workflows#schedule) (defaults to every 6 hours).
- Maybe you want to trigger it manually to see the effect.

### CLI

**[Archives of precompiled binaries for gfas are available for Windows,
macOS and Linux.](https://github.com/jwcub/gfas/releases)** Linux and
Windows binaries are static executables. Users of platforms not explicitly
mentioned below are advised to download one of these archives.

If you're a **Rust programmer**, gfas can be installed with `cargo`.
Note that the minimum supported version of Rust for gfas is **1.75.0**,
although gfas may work with older versions.

```
$ cargo install gfas
```

Alternatively, one can use [`cargo
binstall`](https://github.com/cargo-bins/cargo-binstall) to install a gfas
binary directly from GitHub:

```
$ cargo binstall gfas
```

After installation, run `gfas --help` for all commands and options.

### API

The
[gfas-api](https://crates.io/crates/gfas-api)
crate exports some
[GitHub API bindings](https://docs.rs/gfas-api)
which can be used to build your application.

```sh
$ cargo add gfas-api
```

```rust
use gfas_api::GitHub;

let github = GitHub::builder().token("<TOKEN>").endpoint("https://api.github.com").build()?;

github.follow("<USER-TO-FOLLOW>").await?;
```

## Building

gfas is written in Rust, so you'll need to grab a
[Rust installation](https://www.rust-lang.org/) in order to compile it.
gfas compiles with Rust 1.72.0 (stable) or newer. In general, gfas tracks
the latest stable release of the Rust compiler.

To build gfas:

```sh
$ git clone https://github.com/jwcub/gfas
$ cd gfas
$ cargo build --release
$ ./target/release/gfas help
```

## Contributing

See [CONTRIBUTING.md](CONTRIBUTING.md).

## License

This project is licensed under the [Unlicense](LICENSE).