Skip to content

Commit 340ec12

Browse files
msrd0msrd0
authored
Use cargo doc2readme instead of cargo readme (#125)
1 parent 8f4e591 commit 340ec12

File tree

7 files changed

+139
-105
lines changed

7 files changed

+139
-105
lines changed

‎.github/PULL_REQUEST_TEMPLATE.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,6 @@
77
- [ ] Linted code using clippy
88
- [ ] with reqwest feature: `cargo clippy --manifest-path influxdb/Cargo.toml --all-targets --no-default-features --features use-serde,derive,reqwest-client -- -D warnings`
99
- [ ] with surf feature: `cargo clippy --manifest-path influxdb/Cargo.toml --all-targets --no-default-features --features use-serde,derive,hyper-client -- -D warnings`
10-
- [ ] Updated README.md using `cargo readme -r influxdb -t ../README.tpl > README.md`
10+
- [ ] Updated README.md using `cargo doc2readme -p influxdb --expand-macros`
1111
- [ ] Reviewed the diff. Did you leave any print statements or unnecessary comments?
1212
- [ ] Any unfinished work that warrants a separate issue captured in an issue with a TODO code comment

‎.github/workflows/rust.yml

+4-3
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,10 @@ jobs:
1313
runs-on: ubuntu-latest
1414
steps:
1515
- uses: actions/checkout@v3
16-
- uses: dtolnay/rust-toolchain@nightly
17-
- run: bash ./auxiliary/update_cargo-readme.sh
18-
- run: bash ./auxiliary/check_readme_consistency.sh
16+
- uses: docker://ghcr.io/msrd0/cargo-doc2readme:nightly
17+
with:
18+
entrypoint: cargo
19+
args: doc2readme -p influxdb --expand-macros --check
1920

2021
# this checks that there are no clippy lints
2122
clippy:

‎README.tpl ‎README.j2

+6-1
Original file line numberDiff line numberDiff line change
@@ -32,4 +32,9 @@
3232

3333
{{readme}}
3434

35-
@ 2020 Gero Gerke and [contributors](https://github.com/influxdb-rs/influxdb-rust/graphs/contributors).
35+
@ 2020 Gero Gerke and [contributors].
36+
37+
[contributors]: https://github.com/influxdb-rs/influxdb-rust/graphs/contributors
38+
{%- if links != "" %}
39+
{{ links }}
40+
{% endif -%}

‎README.md

+88-49
Original file line numberDiff line numberDiff line change
@@ -30,33 +30,36 @@
3030
</a>
3131
</p>
3232

33-
This library is a work in progress. This means a feature you might need is not implemented
34-
yet or could be handled better.
33+
This library is a work in progress. This means a feature you might need is not implemented yet or could be handled better.
34+
35+
Pull requests are always welcome. See [Contributing][__link0] and [Code of Conduct][__link1]. For a list of past changes, see [CHANGELOG.md][__link2].
3536

36-
Pull requests are always welcome. See [Contributing](https://github.com/influxdb-rs/influxdb-rust/blob/main/CONTRIBUTING.md) and [Code of Conduct](https://github.com/influxdb-rs/influxdb-rust/blob/main/CODE_OF_CONDUCT.md). For a list of past changes, see [CHANGELOG.md](https://github.com/influxdb-rs/influxdb-rust/blob/main/CHANGELOG.md).
3737

3838
### Currently Supported Features
3939

40-
- Reading and Writing to InfluxDB
41-
- Optional Serde Support for Deserialization
42-
- Running multiple queries in one request (e.g. `SELECT * FROM weather_berlin; SELECT * FROM weather_london`)
43-
- Writing single or multiple measurements in one request (e.g. `WriteQuery` or `Vec<WriteQuery>` argument)
44-
- Authenticated and Unauthenticated Connections
45-
- `async`/`await` support
46-
- `#[derive(InfluxDbWriteable)]` Derive Macro for Writing / Reading into Structs
47-
- `GROUP BY` support
48-
- Tokio and async-std support (see example below) or [available backends](https://github.com/influxdb-rs/influxdb-rust/blob/main/influxdb/Cargo.toml)
49-
- Swappable HTTP backends ([see below](#Choice-of-HTTP-backend))
40+
- Reading and Writing to InfluxDB
41+
- Optional Serde Support for Deserialization
42+
- Running multiple queries in one request (e.g. `SELECT * FROM weather_berlin; SELECT * FROM weather_london`)
43+
- Writing single or multiple measurements in one request (e.g. `WriteQuery` or `Vec<WriteQuery>` argument)
44+
- Authenticated and Unauthenticated Connections
45+
- `async`/`await` support
46+
- `#[derive(InfluxDbWriteable)]` Derive Macro for Writing / Reading into Structs
47+
- `GROUP BY` support
48+
- Tokio and async-std support (see example below) or [available backends][__link3]
49+
- Swappable HTTP backends ([see below](#Choice-of-HTTP-backend))
50+
5051

5152
## Quickstart
5253

5354
Add the following to your `Cargo.toml`
5455

56+
5557
```toml
56-
influxdb = { version = "0.6", features = ["derive"] }
58+
influxdb = { version = "0.6.0", features = ["derive"] }
5759
```
5860

59-
For an example with using Serde deserialization, please refer to [serde_integration](crate::integrations::serde_integration)
61+
For an example with using Serde deserialization, please refer to [serde_integration][__link4]
62+
6063

6164
```rust
6265
use influxdb::{Client, Query, Timestamp, ReadQuery};
@@ -104,46 +107,82 @@ async fn main() {
104107
}
105108
```
106109

107-
For further examples, check out the Integration Tests in `tests/integration_tests.rs`
108-
in the repository.
110+
For further examples, check out the Integration Tests in `tests/integration_tests.rs` in the repository.
111+
109112

110113
## Choice of HTTP backend
111114

112115
To communicate with InfluxDB, you can choose the HTTP backend to be used configuring the appropriate feature. We recommend sticking with the default reqwest-based client, unless you really need async-std compatibility.
113116

114-
- **[hyper](https://github.com/hyperium/hyper)** (through reqwest, used by default), with [rustls](https://github.com/ctz/rustls)
115-
```toml
116-
influxdb = { version = "0.6", features = ["derive"] }
117-
```
118-
119-
- **[hyper](https://github.com/hyperium/hyper)** (through reqwest), with native TLS (OpenSSL)
120-
```toml
121-
influxdb = { version = "0.6", default-features = false, features = ["derive", "use-serde", "reqwest-client"] }
122-
```
123-
124-
- **[hyper](https://github.com/hyperium/hyper)** (through surf), use this if you need tokio 0.2 compatibility
125-
```toml
126-
influxdb = { version = "0.6", default-features = false, features = ["derive", "use-serde", "curl-client"] }
127-
```
128-
- **[curl](https://github.com/alexcrichton/curl-rust)**, using [libcurl](https://curl.se/libcurl/)
129-
```toml
130-
influxdb = { version = "0.6", default-features = false, features = ["derive", "use-serde", "curl-client"] }
131-
```
132-
- **[async-h1](https://github.com/http-rs/async-h1)** with native TLS (OpenSSL)
133-
```toml
134-
influxdb = { version = "0.6", default-features = false, features = ["derive", "use-serde", "h1-client"] }
135-
```
136-
- **[async-h1](https://github.com/http-rs/async-h1)** with [rustls](https://github.com/ctz/rustls)
137-
```toml
138-
influxdb = { version = "0.6", default-features = false, features = ["derive", "use-serde", "h1-client-rustls"] }
139-
```
140-
- WebAssembly's `window.fetch`, via `web-sys` and **[wasm-bindgen](https://github.com/rustwasm/wasm-bindgen)**
141-
```toml
142-
influxdb = { version = "0.6", default-features = false, features = ["derive", "use-serde", "wasm-client"] }
143-
```
117+
- **[hyper][__link5]** (through reqwest, used by default), with [rustls][__link6]
118+
```toml
119+
influxdb = { version = "0.6.0", features = ["derive"] }
120+
```
121+
122+
123+
- **[hyper][__link7]** (through reqwest), with native TLS (OpenSSL)
124+
```toml
125+
influxdb = { version = "0.6.0", default-features = false,features = ["derive", "use-serde", "reqwest-client"] }
126+
```
127+
128+
129+
- **[hyper][__link8]** (through surf), use this if you need tokio 0.2 compatibility
130+
```toml
131+
influxdb = { version = "0.6.0", default-features = false,features = ["derive", "use-serde", "hyper-client"] }
132+
```
133+
134+
135+
- **[curl][__link9]**, using [libcurl][__link10]
136+
```toml
137+
influxdb = { version = "0.6.0", default-features = false,features = ["derive", "use-serde", "curl-client"] }
138+
```
139+
140+
141+
- **[async-h1][__link11]** with native TLS (OpenSSL)
142+
```toml
143+
influxdb = { version = "0.6.0", default-features = false,features = ["derive", "use-serde", "h1-client"] }
144+
```
145+
146+
147+
- **[async-h1][__link12]** with [rustls][__link13]
148+
```toml
149+
influxdb = { version = "0.6.0", default-features = false,features = ["derive", "use-serde", "h1-client-rustls"] }
150+
```
151+
152+
153+
- WebAssembly’s `window.fetch`, via `web-sys` and **[wasm-bindgen][__link14]**
154+
```toml
155+
influxdb = { version = "0.6.0", default-features = false,features = ["derive", "use-serde", "wasm-client"] }
156+
```
157+
158+
159+
144160

145161
## License
146162

147-
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
163+
[![License: MIT][__link15]][__link16]
164+
165+
166+
167+
@ 2020 Gero Gerke and [contributors].
168+
169+
[contributors]: https://github.com/influxdb-rs/influxdb-rust/graphs/contributors
170+
[__cargo_doc2readme_dependencies_info]: ggGkYW0BYXSEG-eS3ZnLalPKG8RSyE7OgxOuG5N_7FO9S6I9G5Bq0rFyX93cYXKEGyBiJeIUzlcaG-d2lJz85cl_G-crYZ-mhyAvG6Wf1YbqYiItYWSBgmhpbmZsdXhkYmUwLjYuMA
171+
[__link0]: https://github.com/influxdb-rs/influxdb-rust/blob/main/CONTRIBUTING.md
172+
[__link1]: https://github.com/influxdb-rs/influxdb-rust/blob/main/CODE_OF_CONDUCT.md
173+
[__link10]: https://curl.se/libcurl/
174+
[__link11]: https://github.com/http-rs/async-h1
175+
[__link12]: https://github.com/http-rs/async-h1
176+
[__link13]: https://github.com/ctz/rustls
177+
[__link14]: https://github.com/rustwasm/wasm-bindgen
178+
[__link15]: https://img.shields.io/badge/License-MIT-yellow.svg
179+
[__link16]: https://opensource.org/licenses/MIT
180+
[__link2]: https://github.com/influxdb-rs/influxdb-rust/blob/main/CHANGELOG.md
181+
[__link3]: https://github.com/influxdb-rs/influxdb-rust/blob/main/influxdb/Cargo.toml
182+
[__link4]: https://docs.rs/influxdb/0.6.0/influxdb/?search=integrations::serde_integration
183+
[__link5]: https://github.com/hyperium/hyper
184+
[__link6]: https://github.com/ctz/rustls
185+
[__link7]: https://github.com/hyperium/hyper
186+
[__link8]: https://github.com/hyperium/hyper
187+
[__link9]: https://github.com/alexcrichton/curl-rust
148188

149-
@ 2020 Gero Gerke and [contributors](https://github.com/influxdb-rs/influxdb-rust/graphs/contributors).

‎auxiliary/check_readme_consistency.sh

-14
This file was deleted.

‎auxiliary/update_cargo-readme.sh

-11
This file was deleted.

‎influxdb/src/lib.rs

+40-26
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,7 @@
2020
//!
2121
//! Add the following to your `Cargo.toml`
2222
//!
23-
//! ```toml
24-
//! influxdb = { version = "0.6", features = ["derive"] }
25-
//! ```
23+
#![doc = cargo_toml!(indent="", "derive")]
2624
//!
2725
//! For an example with using Serde deserialization, please refer to [serde_integration](crate::integrations::serde_integration)
2826
//!
@@ -80,35 +78,19 @@
8078
//! To communicate with InfluxDB, you can choose the HTTP backend to be used configuring the appropriate feature. We recommend sticking with the default reqwest-based client, unless you really need async-std compatibility.
8179
//!
8280
//! - **[hyper](https://github.com/hyperium/hyper)** (through reqwest, used by default), with [rustls](https://github.com/ctz/rustls)
83-
//! ```toml
84-
//! influxdb = { version = "0.6", features = ["derive"] }
85-
//! ```
86-
//!
81+
#![doc = cargo_toml!(indent="\t", "derive")]
8782
//! - **[hyper](https://github.com/hyperium/hyper)** (through reqwest), with native TLS (OpenSSL)
88-
//! ```toml
89-
//! influxdb = { version = "0.6", default-features = false, features = ["derive", "use-serde", "reqwest-client"] }
90-
//! ```
91-
//!
83+
#![doc = cargo_toml!(indent="\t", default-features = false, "derive", "use-serde", "reqwest-client")]
9284
//! - **[hyper](https://github.com/hyperium/hyper)** (through surf), use this if you need tokio 0.2 compatibility
93-
//! ```toml
94-
//! influxdb = { version = "0.6", default-features = false, features = ["derive", "use-serde", "curl-client"] }
95-
//! ```
85+
#![doc = cargo_toml!(indent="\t", default-features = false, "derive", "use-serde", "hyper-client")]
9686
//! - **[curl](https://github.com/alexcrichton/curl-rust)**, using [libcurl](https://curl.se/libcurl/)
97-
//! ```toml
98-
//! influxdb = { version = "0.6", default-features = false, features = ["derive", "use-serde", "curl-client"] }
99-
//! ```
87+
#![doc = cargo_toml!(indent="\t", default-features = false, "derive", "use-serde", "curl-client")]
10088
//! - **[async-h1](https://github.com/http-rs/async-h1)** with native TLS (OpenSSL)
101-
//! ```toml
102-
//! influxdb = { version = "0.6", default-features = false, features = ["derive", "use-serde", "h1-client"] }
103-
//! ```
89+
#![doc = cargo_toml!(indent="\t", default-features = false, "derive", "use-serde", "h1-client")]
10490
//! - **[async-h1](https://github.com/http-rs/async-h1)** with [rustls](https://github.com/ctz/rustls)
105-
//! ```toml
106-
//! influxdb = { version = "0.6", default-features = false, features = ["derive", "use-serde", "h1-client-rustls"] }
107-
//! ```
91+
#![doc = cargo_toml!(indent="\t", default-features = false, "derive", "use-serde", "h1-client-rustls")]
10892
//! - WebAssembly's `window.fetch`, via `web-sys` and **[wasm-bindgen](https://github.com/rustwasm/wasm-bindgen)**
109-
//! ```toml
110-
//! influxdb = { version = "0.6", default-features = false, features = ["derive", "use-serde", "wasm-client"] }
111-
//! ```
93+
#![doc = cargo_toml!(indent="\t", default-features = false, "derive", "use-serde", "wasm-client")]
11294
//!
11395
//! # License
11496
//!
@@ -118,6 +100,38 @@
118100
#![allow(clippy::needless_lifetimes)] // False positive in client/mod.rs query fn
119101
#![forbid(bare_trait_objects)]
120102

103+
macro_rules! cargo_toml {
104+
(indent=$indent:literal, $firstfeat:literal $(, $feature:literal)*) => {
105+
cargo_toml_private!($indent, "", $firstfeat $(, $feature)*)
106+
};
107+
108+
(indent=$indent:literal, default-features = false, $firstfeat:literal $(, $feature:literal)*) => {
109+
cargo_toml_private!($indent, "default-features = false,", $firstfeat $(, $feature)*)
110+
};
111+
}
112+
113+
macro_rules! cargo_toml_private {
114+
($indent:literal, $deffeats:literal, $firstfeat:literal $(, $feature:literal)*) => {
115+
concat!(
116+
$indent,
117+
"```toml\n",
118+
119+
$indent,
120+
"influxdb = { version = \"",
121+
env!("CARGO_PKG_VERSION"),
122+
"\", ",
123+
$deffeats,
124+
"features = [",
125+
"\"", $firstfeat, "\"",
126+
$(", \"", $feature, "\"",)*
127+
"] }\n",
128+
129+
$indent,
130+
"```"
131+
)
132+
};
133+
}
134+
121135
#[cfg(all(feature = "reqwest", feature = "surf"))]
122136
compile_error!("You need to choose between reqwest and surf; enabling both is not supported");
123137

0 commit comments

Comments
 (0)