netrc-parser 0.1.0

A Rust library for parsing and manipulating .netrc files
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

# netrc-parser

A Rust library for parsing and manipulating `.netrc` files.

`netrc-parser` provides a modern, idiomatic parser for `.netrc` files, supporting machine entries, login credentials, accounts, and macro definitions (`macdef`). It includes serialization to JSON and TOML, file I/O, and comprehensive error handling.

## Installation

Add to your `Cargo.toml`:

```toml
[dependencies]
netrc-parser = "0.1.0"
```

## Usage

Parse a `.netrc` file and retrieve credentials:

```rust
use netrc_parser::{Netrc, NetrcError};

fn main() -> Result<(), NetrcError> {
    let path = dirs::home_dir()
        .ok_or_else(|| NetrcError::FileNotFound("Home directory not found".to_string()))?
        .join(".netrc");
    let netrc = Netrc::parse_from_path(&path)?;
    if let Some(creds) = netrc.get("surge.surge.sh") {
        println!("Login: {}, Password: {}", creds.login, creds.password);
    }
    Ok(())
}
```

### Run the example

```sh
cargo run --example simple
```

## Documentation

Run `cargo doc --open` to view the API documentation.

## Development

### Format code with rustfmt nightly

```sh
rustup toolchain install nightly
rustup component add rustfmt --toolchain nightly
cargo +nightly fmt
```

## License

Licensed under the MIT. See [LICENSE](./LICENSE) for details.

## Contributing

Contributions are welcome! Please open a issue or pull request on [Github](https://github.com/dantescur/netrc-parser)