Skip to content

Update harvester source commands - #479

Open
frafra wants to merge 1 commit into
ckan:masterfrom
frafra:patch-1
Open

Update harvester source commands#479
frafra wants to merge 1 commit into
ckan:masterfrom
frafra:patch-1

Conversation

@frafra

@frafra frafra commented Nov 16, 2021

Copy link
Copy Markdown
Contributor

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

seitenbau-govdata commented Nov 29, 2021

Copy link
Copy Markdown
Member

@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

frafra commented Nov 29, 2021

Copy link
Copy Markdown
Contributor Author

@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

Copy link
Copy Markdown
Member

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

frafra commented Dec 1, 2021

Copy link
Copy Markdown
Contributor Author

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

seitenbau-govdata commented Dec 1, 2021

Copy link
Copy Markdown
Member

@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

frafra commented Dec 1, 2021

Copy link
Copy Markdown
Contributor Author

Sorry for the confusion. My PR is incomplete indeed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants