Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add documentation on how to extend scraper #36

Open
jfredrickson5 opened this issue May 17, 2019 · 0 comments
Open

Add documentation on how to extend scraper #36

jfredrickson5 opened this issue May 17, 2019 · 0 comments

Comments

@jfredrickson5
Copy link
Collaborator

Right now, the tool is fairly straightforward to extend if one goes through the source code, but there's currently no documentation on how to do it. Developers looking to leverage scraper for their source control platforms that are not yet supported (e.g., Subversion) would benefit from some kind of reference in order to figure out the integration points.

I'm curious what approach might work best:

  1. Add a lightweight plugin system, where contributors can write their own Python packages, install them via pip, and add their config to config.json. Scraper simply invokes each plugin listed in the config and integrates the returned metadata into the final code.json file.

or

  1. Don't modify scraper, just add comprehensive documentation on how contributors can add a new module. Contributors can then open a PR to merge the new feature.
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

No branches or pull requests

1 participant