ghtkn 0.1.1

GitHub token management — OAuth device flow with keyring caching and config-driven app selection
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

//! GitHub token management via OAuth device flow.
//!
//! `ghtkn` provides a complete SDK for obtaining GitHub access tokens through
//! the OAuth device authorization grant flow (RFC 8628). Tokens are cached in
//! the system keyring for reuse across sessions.
//!
//! # Quick start
//!
//! ```no_run
//! use ghtkn::{Client, InputGet};
//!
//! # async fn run() -> ghtkn::Result<()> {
//! let client = Client::new();
//! let (token, app) = client.get(&InputGet::default()).await?;
//! println!("Token for {}: {}...", app.name, &token.access_token[..8]);
//! # Ok(())
//! # }
//! ```

pub mod api;
pub mod browser;
pub mod config;
pub mod deviceflow;
pub mod error;
pub mod github;
pub mod keyring;
pub mod log;

// -- Primary API --
pub use api::{Client, InputGet, TokenSource};

// -- Browser --
pub use browser::{Browser, BrowserError, DefaultBrowser};

// -- Config --
pub use config::{App, Config};

// -- Device flow --
pub use deviceflow::{DeviceCodeResponse, DeviceCodeUI, SimpleDeviceCodeUI};

// -- Errors --
pub use error::{Error, Result};

// -- GitHub --
pub use github::GitHubClient;

// -- Keyring --
pub use keyring::{AccessToken, DEFAULT_SERVICE_KEY};

// -- Logger --
pub use log::Logger;

/// Return the default config file path for the current platform.
///
/// Delegates to [`config::get_path`] with the real environment and OS.
pub fn get_config_path() -> Result<String> {
    let path = config::get_path(|k| std::env::var(k).ok(), std::env::consts::OS)?;
    path.to_str()
        .map(|s| s.to_string())
        .ok_or_else(|| Error::Config("config path contains non-UTF-8 characters".into()))
}