hitchstory
cheat
hitchstory | cheat | |
---|---|---|
23 | 32 | |
84 | 11,963 | |
- | 1.0% | |
9.1 | 5.2 | |
16 days ago | 12 days ago | |
Python | Go | |
GNU General Public License v3.0 or later | MIT License |
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.
hitchstory
- Hitchstory – Type-safe StrictYAML Python integration testing framework
-
Winner of the SF Mistral AI Hackathon: Automated Test Driven Prompting
I built something like this too:
https://github.com/hitchdev/hitchstory/blob/master/examples%...
- Prompt Engineering Testing Framework
-
Non-code contributions are the secret to open source success
I took the same approach to "docs are tests and tests are docs" with integration testing when I created this library: https://github.com/hitchdev/hitchstory
I realized at some point that a test and a how-to guide can and should actually be the same thing - not just for doctests, but for every kind of test.
It's not only 2x quicker to combine writing a test with writing docs, the test part and the docs part reinforce each other:
* Tests are more easily understandable when you attach written context intended for human consumption.
* Docs are better if they come attached to a guarantee that they're valid, not out of date and not missing crucial details.
* TDD is better if how-to docs are created as a side effect.
-
Ask HN: Are there any LLM projects for creating integration tests?
I have created a project for easily writing this type of test with YAML:
https://github.com/hitchdev/hitchstory
I dont think that this type of task is really appropriate for an LLM though. It is better to use hard abstractions for the truly deterministic stuff and for other stuff where you may need to do subtle trade offs (e.g. choosing a selector for the search bar) an LLM will generally do a bad job.
-
Should you add screenshots to documentation?
For those interested in the concept of having permanently up-to-date documentation with screenshots I built this testing framework based upon the idea that good documentation can be a autogenerated artefact of good tests:
https://github.com/hitchdev/hitchstory
-
How to add documentation to your product life cycle
I don't like gherkin. It's it has very awkward syntax, it's not type safe, it's very verbose, it has no ability to abstract scenarios and rather than being a source for generating the documentation it tries to be the documentation.
Nonetheless, there is a small number of projects where they either work around this or it doesn't matter as much. I find that most people that apply gherkin to their projects find it doesn't work - usually for one of the above reasons.
I built https://github.com/hitchdev/hitchstory as an alternative that has straightforward syntax (YAML), very strict type safety (StrictYAML), low verbosity, and is explicitly designed as a source for generating documentation rather than trying to be the documentation.
-
Beyond OpenAPI
I built this because I had the same idea: https://github.com/hitchdev/hitchstory
If the specification can be tested and used to generate docs and can be rewritten based upon program output then the maintenance cost for producing docs like these plunges.
-
Optimizing Postgres's Autovacuum for High-Churn Tables
-c fsync=off -c synchronous_commit=off -c full_page_writes=off
I got the answer from Karen Jex at Djangocon 2023.
I used it to build some integration tests which exhibit best practices: https://github.com/hitchdev/hitchstory/tree/master/examples/...
I considered using tmpfs but I wanted to cache the entire database volume and couldnt figure out how to do that with podman.
-
Elixir Livebook is a secret weapon for documentation
This is incredible work.
To anyone curious, I highly recommend:
- https://hitchdev.com/hitchstory/approach/
- https://hitchdev.com/hitchstory/why-not/
From the overall RDD/BDD type home page:
- https://hitchdev.com/hitchstory/
The entire product site is a thing of richly informative beauty.
---
My only question was whether the generated 'docs' snippets would add value over just reading the story in your DASL. Any markdown site generator (such as the chosen Material for MKDocs) can just embed the ```yaml anyway. But then I realized what was generating e.g. …
- https://hitchdev.com/hitchstory/using/engine/rewrite-story/
… and how superior that is to typical docs, especially typical docstring or swagger factories.
cheat
-
Should you add screenshots to documentation?
Looks like bro pages is archived and they recommend https://github.com/tldr-pages/tldr or https://github.com/cheat/cheat
-
Was looking at the GitHub page for eg and found this gem
I tried eg and tldr, but I preferred cheat. Why, and why not. Cheat not only have nice examples, but let you improve them or create yours. I use the cli, not the curl.
-
This sub turned me onto Raycast, but... No syncing of settings / keyboard shortcuts between machines??
Hey, the app I recommend shows you all the commands you need per app not just for macOS! Support for programming languages? Download this. For git, docker and neovim download this one.
-
Aid needed
cheat is also a useful one. Shows you a cheat sheet for the command you search.
-
how to enable cheat autocompletion in zsh
are you sure autocompletion isn't enabled for cheat? You're maybe hitting this bug upstream.
-
What is a good way to learn bash scripting
Find something to automate or make easier and write a script for it. If you get stuck on a detail, read the man pages of the command you're using (man pages confuse you? try tldr or cheat). Then google it, there's a shitton of SO Q&A on bash. If you can't find it, find a bash channel on irc or discord and ask (they'll expect you've read the FAQ though). Keep notes. I wrote a script to read and edit notes for bash, in bash, and it taught me new things!
-
Do you ever use cheat sheets at work?
Definitely do. I created my own doc site using docusaurus where i stored a lot of info i use every once in a while. Things i use more often are available as aliases in the shell or zsh functions. There's also the handy dandy cli https://github.com/cheat/cheat that contains a lot of cheat sheets for common binaries.
-
Why can't I hold all these syntaxes?
cheat and howdoi
- Ask HN: Terminal Cheatsheets
-
My thoughts after a week of ChatGPT usage
As a dev - It's a good (very good, in fact) alternative for man, tldr, cheat and zeal (and probably tens of other projects - sorry for not mentioning you) with a very pleasant interface - which was the point I think ;)
What are some alternatives?
bumblebee - Pre-trained Neural Network models in Axon (+ 🤗 Models integration)
tldr - 📚 Collaborative cheatsheets for console commands
testy - test helpers for more meaningful, readable, and fluent tests
cheat.sh - the only cheat sheet you need
ospec - Noiseless testing framework
tealdeer - A very fast implementation of tldr in Rust.
jsverify - Write powerful and concise tests. Property-based testing for JavaScript. Like QuickCheck.
tldr - Haskell tldr client
examples - Tests that rewrite themselves. Tests that rewrite your docs.
pywal - 🎨 Generate and change color-schemes on the fly.
explorer - Series (one-dimensional) and dataframes (two-dimensional) for fast and elegant data exploration in Elixir
howdoi - instant coding answers via the command line