Comments (3)
ParthS007
commented on September 22, 2024
@tiborsimko Can you please explain a bit more about the expected result from this issue?
What I have understood is we have to generate the CLI docs with help of sphinx-click.
from cernopendata-client.
tiborsimko
commented on September 22, 2024
The higher goal is to have an up-to-date info about CLI commands and options on ReadTheDocs here: https://cernopendata-client.readthedocs.io/en/latest/cliapi.html
However, we cannot install project on ReadTheDocs due to pycurl dependency troubles.
Two solutions:
- Make pycurl optional, see #78. This will make the package installable also on ReadTheDocs, solving the main goal that way.
- Generate
cliapi.mdcontent locally on our laptops while developing, with each feature branch, so that ReadTheDocs wouldn't have to. This is a bit similar to REANA and howdocs/openapi.jsonis generated. See e.g.reana-workflow-controllerand itsrun-tests.shandscripts/generate_openapi_spec.py. We'd have to develop something similar for click-generated docs.
from cernopendata-client.
ParthS007
commented on September 22, 2024
I have made PR for #78 going for first option. We can turn on the project installation on RTD to check if cli docs are building on their own.
from cernopendata-client.
Related Issues (20)
- walker: enrich output with parent directories
- Consistency between top-level CLI notion behind "protocol" and low-level Searcher notion behind "protocol"
- cernopendata-client get-metadata --recid 550 --output-value title
- searcher: JSON Decode error for `--verbose`
- CI: Test on multiple enviornments
- file locations: distinguish between EOSPUBLIC and OPENDATA URIs
- download-files: expose HTTP downloader choice (requests vs pycurl) HOT 1
- download-files: success for 5000, failure for 12341
- installation: xrootd troubles HOT 1
- downloader: CLI breaks when record has no files
- Raise exceptions when using the methods outside the CLI
- Download with docker - where do the files go? HOT 2
- Parallelize Downloads
- cli: add support for multiple filter arguments in the get-metadata command
- Verbose mode in get-file-locations HOT 1
- downloader: partial downloads are marked as success:
- cernopendata-client get-file-locations --recid 282 --protocol xrootd --verbose HOT 1
- searcher: separate out get_list_directory() and friends
- downloader: catch more error situations HOT 4
- downloader: resume interrupted downloads HOT 3
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from cernopendata-client.