search

ckan / ckanext-harvest

Remote harvesting extension for CKAN
130 stars 203 forks source link

Update harvester source commands #479

Open frafra opened 2 years ago

frafra commented 2 years ago

README.md does not reflect current options:

Usage: ckan harvester source [OPTIONS] COMMAND [ARGS]...

  Manage harvest sources

Options:
  --help  Show this message and exit.

Commands:
  clear          Clears all datasets, jobs and objects related to a harvest...
  clear-history  If no source id is given the history for all harvest...
  create         Create new harvest source.
  remove         Remove (deactivate) a harvester source, whilst leaving any...
  show           Shows a harvest source.
seitenbau-govdata commented 2 years ago

@frafra In my opinion the information about the command line CKAN commands in the README.rst in this repository is equal to the commands usage documentation in harvester.py and corresponds to the implementation. Or did I missed something?

frafra commented 2 years ago

@frafra In my opinion the information about the command line CKAN commands in the README.rst in this repository is equal to the commands usage documentation in harvester.py and corresponds to the implementation. Or did I missed something?

It does not, from what I see.

seitenbau-govdata commented 2 years ago

README.md does not reflect current options:

Usage: ckan harvester source [OPTIONS] COMMAND [ARGS]...

  Manage harvest sources

Options:
  --help  Show this message and exit.

Commands:
  clear          Clears all datasets, jobs and objects related to a harvest...
  clear-history  If no source id is given the history for all harvest...
  create         Create new harvest source.
  remove         Remove (deactivate) a harvester source, whilst leaving any...
  show           Shows a harvest source.

You are referencing to a README.md file, but in the repository is only a README.rst file. The file extension differs. And the usage string in harvester.py is different to your pasted excerpt.

frafra commented 2 years ago

Both README.rst and the docstring do not reflect what I see from the command line, which is what I posted in the first comment, which is the implementation.

seitenbau-govdata commented 2 years ago

@frafra I have realized now that you mean the new click commands cli.py in combination with CKAN 2.9. At the moment the README.rst covers only the paster command harvester.py. But they are even more different than only the source command, so I would suggest to add the click commands usage info additionally to the paster command usage info on the README.rst.

frafra commented 2 years ago

Sorry for the confusion. My PR is incomplete indeed.