cli-guidelines
connexion
cli-guidelines | connexion | |
---|---|---|
47 | 23 | |
2,788 | 4,420 | |
0.9% | 0.3% | |
3.6 | 8.2 | |
about 1 month ago | 4 days ago | |
CSS | Python | |
Creative Commons Attribution Share Alike 4.0 | Apache License 2.0 |
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.
cli-guidelines
- Ask HN: Where to read about terminal UIs?
-
Ask HN: Do you read Secrets from Environment Variables
The Command Line Interface Guidelines [1] says:
> Do not read secrets from environment variables
> Secrets should only be accepted via credential files, pipes, `AF_UNIX` sockets, secret management services, or another IPC mechanism
Which one of these do you use? On github it seems common for projects to use environment variables for secrets.
[1] https://clig.dev/#environment-variables
-
Command Line Interface Guidelines
Seems they took a small step back from their previous "don't bother with man pages" stance. Now it's "Consider providing man pages."
I still find it a rather shocking order of priority, honestly.
https://clig.dev/#documentation
-
Ask HN: Best way to do scoped commands in a CLI app
- E. `blah project foo --edit`
Wondering if there was any guidance on this from the UNIX people. Perhaps scoping should be done using the file system. `cd path/to/project && blah edit`. Like git does with `git --cwd=path/to/project`. Maybe a virtual FS could even be used. Then you wouldn't have to continuously type in the scope with each command. Interesting thinking about how to maintain state in the terminal...thinking about how Python's virtual env bin/activate modifies the shell.
Found an interesting guide here: https://clig.dev/
-
CLI user experience case study
Capturing these guidelines is one of the primary reasons that https://clig.dev/ exists.
-
Introducing my Password Manager project - Seeking Feedback and Contributions
You may want to take a look at various existing CLIs to get inspiration on how they operate, the user feedback loop and the ergonomics on using them. Here is a great website on some CLI structing guidance https://clig.dev/
connexion
-
Write OpenAPI with TypeSpec
I like the idea, especially the TS-like syntax around enums and union types. I've always preferred the SDL for GraphQL vs writing OpenAPI for similar reasons.
I echo the sentiment others have brought up, which is the trade-offs of a code-driven schema vs schema-driven code.
At work we use Pydantic and FastAPI to generate the OpenAPI contract, but there's some cruft and care needed around exposing those underlying Pydantic models through the API documentation. It's been easy to create schemas that have compatibility problems when run through other code generators. I know there are projects such as connexction[1] which attempt to inverse this, but I don't have much experience with it. In the GraphQL space it seems that code-first approaches are becoming more favored, though there's a different level of complexity needed to create a "typesafe" GraphQL server (eg. model mismatches between root query resolvers and field resolvers).
[1] https://github.com/spec-first/connexion
-
Connexion 3 released!
Connexion is a popular Python web framework (~ 5 million downloads per month) that makes spec-first and api-first development easy. You describe your API in an OpenAPI (or swagger) specification with as much detail as you want and Connexion will guarantee that it works as you specified.
- Connexion 3.0 Released
-
Show HN: REST Alternative to GraphQL and tRPC
> While REST APIs don't generally provide the same level of control to clients as GraphQL, many times this could be seen as a benefit especially in scenarios where strict control over data access and operations is crucial.
Rest is more secure, cacheable, and more performant on the server side as field resolution doesn't need to happen like it does with GraphQL. It is not more performant on the client side, and this is a trade-off, but I favor rest applications over GraphQL ones as a DevOps engineer. They are much easier to administer infrastructure-wise, I can cache the requests, etc.
Data at our company suggests that several small queries actually do better performance-wise than one large one. We switched to GraphQL a year and a half ago or so, but this piece of data seems to suggest that we might have been better off just sticking with REST. My suggestion to that effect was not met with optimism either on the client or server side. Apparently there are server-side benefits as well, allowing for more modular development or something like that.
I have used OpenAPI using connexion[1]. It was hard to understand at first, but I really liked that the single source of truth was one schema. It also made it really easy to develop against the API because it came with a UI that showed the documentation for all the rest end points and even had test buttons.
1: https://connexion.readthedocs.io/en/latest/
-
Ask HN: Why is there no specification for Command Line Interfaces?
What's the use case? I was thinking about this exact issue because my product ships several CLI tools, but I wasn't convinced it would be worth the effort.
An OpenAPI specification describes an HTTP interface, and I see it as useful because it makes it easier to write code in language-of-choice to generate HTTP requests (by generating client libraries from the OpenAPI spec).
For a CLI, the interface is the command-line. Usually people type these commands, or they end up in bash scripts, or sometimes they get called from programming language of choice by shelling out to the CLI. So I could see a use case for a CLI spec, which would make it easier to generate client libraries (which would shell out to the CLI)... but it seems a little niche.
Or maybe, as input to a documentation tool (like Swagger docs). I would imagine if you're using a CLI library like Python's Click, most of that data is already there. Click Parameters documentation: https://click.palletsprojects.com/en/8.1.x/parameters/
Or maybe, you could start from the spec and then generate code which enforces it. So any changes pass through the spec, which would make it easy to write code (server and client-side) / documentation / changelogs. Some projects like this: Guardrail (Scala) https://github.com/guardrail-dev/guardrail , and Connexion (Python) https://github.com/spec-first/connexion .
But without this ecosystem of tooling, documenting your CLI in a specification didn't really seem worth the effort. Of course, that's a bootstrapping problem.
-
Flask is Great!
Connexion is a framework on top of Flask that automagically handles HTTP requests defined using OpenAPI/Swagger.
-
What is the best practice for mapping JSON requests to objects and back to JSON?
I recommend you create a OpenAPI Specification and implement a python module that you expose via connexion or on the cli via click(for easy testing).
-
Flask-Powered APIs: Fast, Reliable, and Used by the World's Top Companies
I'm here because Swagger-CodeGen created flask-Connexion boilerplate for python.
- Python REST APIs With Flask, Connexion, and SQLAlchemy – Part 1 – Real Python
-
Does anybody know any good resources I could use to study ISP architecture?
Personally we just prov them using librouteros and flask-connexion/openapi.
What are some alternatives?
redox - Mirror of https://gitlab.redox-os.org/redox-os/redox
flask-restful - Simple framework for creating REST APIs
nodejs-cli-apps-best-practices - The largest Node.js CLI Apps best practices list ✨
Flask RestPlus - Fully featured framework for fast, easy and documented API development with Flask
bubblewrap - Low-level unprivileged sandboxing tool used by Flatpak and similar projects
flasgger - Easy OpenAPI specs and Swagger UI for your Flask API
typer - Typer, build great CLIs. Easy to code. Based on Python type hints.
django-rest-framework - Web APIs for Django. 🎸
argparse-benchmarks-rs - Collected benchmarks for arg parsing crates written in Rust [Moved to: https://github.com/rosetta-rs/argparse-rosetta-rs]
eve - REST API framework designed for human beings
picocli - Picocli is a modern framework for building powerful, user-friendly, GraalVM-enabled command line apps with ease. It supports colors, autocompletion, subcommands, and more. In 1 source file so apps can include as source & avoid adding a dependency. Written in Java, usable from Groovy, Kotlin, Scala, etc.
falcon - The no-magic web data plane API and microservices framework for Python developers, with a focus on reliability, correctness, and performance at scale.