cram
Functional tests for command line applications (by brodie)
cargo-readme
Generate README.md from docstrings (by webern)
cram | cargo-readme | |
---|---|---|
2 | 5 | |
175 | 339 | |
- | - | |
2.5 | 5.1 | |
almost 2 years ago | about 1 month ago | |
Python | Rust | |
GNU General Public License v3.0 only | GNU General Public License v3.0 or later |
The number of mentions indicates the total number of mentions that we've tracked plus the number of user suggested alternatives.
Stars - the number of stars that a project has on GitHub. Growth - month over month growth in stars.
Activity is a relative number indicating how actively a project is being developed. Recent commits have higher weight than older ones.
For example, an activity of 9.0 indicates that a project is amongst the top 10% of the most actively developed projects that we are tracking.
Stars - the number of stars that a project has on GitHub. Growth - month over month growth in stars.
Activity is a relative number indicating how actively a project is being developed. Recent commits have higher weight than older ones.
For example, an activity of 9.0 indicates that a project is amongst the top 10% of the most actively developed projects that we are tracking.
cram
Posts with mentions or reviews of cram.
We have used some of these posts to build our list of alternatives
and similar projects. The last one was on 2022-04-21.
-
Is it bad practice to start with Jupyter Notebooks?
Yet not all tests are unit tests. In context of classic, non-interactive CLI programs that accept input only through command line parameters and you need to test their output, that's rather functional testing. For such situations, I found this thing to be nice to work with https://github.com/brodie/cram
-
I'd like to review your README
I've been using https://github.com/brodie/cram for this. It's a neat little shell testing tool that can be told to check that every 4-space indented markdown code block output what it says it outputs, so I just cram my README.md.
An example of this in action: https://github.com/liskin/liscopridge/blame/68a656b7beb10a5c..., https://github.com/liskin/liscopridge/blob/68a656b7beb10a5cd...
cargo-readme
Posts with mentions or reviews of cargo-readme.
We have used some of these posts to build our list of alternatives
and similar projects. The last one was on 2022-11-09.
-
List of all third-party cargo subcommands
There’s also this cargo-readme
-
rustdoc comments to markdown?
cargo readme does this (specifically for crate-level documentation), not sure if that’s helpful for your usecase :)
-
Markdown Bakery - Ease maintenance of examples in your MD files
Link in case it's not just me that want aware of it.
-
I'd like to review your README
The README.md isn't part of the rust code, so it's not checked by this unless you use tools to generate your README from doc comments like https://github.com/livioribeiro/cargo-readme.
-
Hey Rustaceans! Got an easy question? Ask here (1/2021)!
I find myself repeating myself between crate-level doc comments and README files. What are people using to avoid that? cargo-readme + a CI hook?
What are some alternatives?
When comparing cram and cargo-readme you can also consider the following projects:
server - :desktop_computer: Simple and powerful server for Node.js
docs.rs - crates.io documentation generator