question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Add a Docat API client/CLI tool

See original GitHub issue

API endpoints are hard to remember and hard to read. A nice-to-have feature would be a Docat API client, which can be used with Python or with the command line.

The Docat CLI tool shall be runnable via a Docker container or via Pip

e.g. Tag:

# Previously:
$ curl -X PUT http://localhost:8000/api/PROJECT/VERSION/tags/latest
# After:
$ docat tag my-project 1.0.0 latest --url http://localhost:8000

Publish:

# Previously:
$ curl -X POST -F "file=@docs.zip" http://localhost:8000/api/PROJECT/VERSION
# After:
$ docat push my-project 1.0.0 ./docs.zip --url http://localhost:8000

(optional) Add a docat.yml config:

$ cat <<EOF > docat.yml
url: http://localhost:8000
project: my-project
EOF

$ docat push 1.0.0 ./docs.zip

or as API client

from docat import tag

tag("my-project", "1.0.0", "latest")

Issue Analytics

  • State:closed
  • Created 3 years ago
  • Reactions:3
  • Comments:7 (7 by maintainers)

github_iconTop GitHub Comments

7reactions
fliiiixcommented, Oct 16, 2021

I close this since https://github.com/docat-org/docatl exists 🌮

2reactions
BrunnerLiviocommented, Oct 16, 2021

Good job @timofurrer. Would have been a “great job” if it was written in JavaScript but ok

Read more comments on GitHub >

github_iconTop Results From Across the Web

mh-cbon/gh-api-cli: Command line client for github api
Package gh-api-cli is a command line utility to work with github api. This tool is part of the go-github-release workflow. TOC. Install.
Read more >
10. Introduction to tower-cli — Ansible Tower API Guide v3.5.3
tower-cli is a command line tool for Ansible Tower. It allows Tower commands to be easily run from the UNIX command line. It...
Read more >
HTTPie – API testing client that flows with you
An open-source API testing client for open minds. $<tool> install httpie.
Read more >
Swagger UI tutorial | Documenting APIs - Idratherbewriting.com
Swagger UI is the tool that transforms your spec into the Petstore-like site. Swagger Codegen: Generates client SDK code for a lot of...
Read more >
CLI Installation - OpenAPI Generator
This page documents how to install the CLI artifact. Installing OpenAPI Generator's CLI tool allows users to generate all available ...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found