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

Documentation on How To Implement a New Provider #213

Open
juftin opened this issue Feb 14, 2023 · 0 comments
Open

Documentation on How To Implement a New Provider #213

juftin opened this issue Feb 14, 2023 · 0 comments
Assignees
Labels
camply provider This is related to a new camply provider

Comments

@juftin
Copy link
Owner

juftin commented Feb 14, 2023

Is your feature request related to a problem? Please describe.

Camply aims to support new local, state, federal, and international camping providers. Currently, there isn't any centralized documentation on this process or an extremely clean provider to be used as an example. Now that ReserveCalifornia has been implemented we have a somewhat simple provider implementation contained within a PR - this is a great example for future providers.

Describe the solution you'd like

Create a clean documentation guide on how to create a new provider. This guide needs to cover the following details:

  • Implementing an ABC Provider Class
  • Implementing the corresponding ABC Search Class
  • Integrating the new provider/search into the CLI
  • Documenting usage of the new provider
  • Link to the aforementioned PR to demonstrate
@juftin juftin added the camply provider This is related to a new camply provider label Feb 14, 2023
@juftin juftin self-assigned this Feb 14, 2023
@github-actions github-actions bot added the triage This will looked at label Feb 14, 2023
@juftin juftin removed the triage This will looked at label Feb 14, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
camply provider This is related to a new camply provider
Projects
None yet
Development

No branches or pull requests

1 participant