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 raw hobolink data as a rest API #77

Open
dwreeves opened this issue Aug 19, 2020 · 2 comments
Open

Add raw hobolink data as a rest API #77

dwreeves opened this issue Aug 19, 2020 · 2 comments
Labels
data Anything related to databases, data management, stuff that is heavily focused in the data directory. good first issue Good for newcomers low priority Issues we are not currently focusing on, either because it has a lot of blockers or isn't important.

Comments

@dwreeves
Copy link
Collaborator

[Note: Do this task in the dev branch]

The base output should be something like this:

return {
        'time_returned': pd.to_datetime()
        'data': df.to_dict(orient='records')
    )

Just do a direct call to get_live_hobolink_data for now.

For parameters, we want hours to be a parameter; default value should be 24. I think that's probably it for now and I'm not sure what else we'd parametrize. (Maybe we can add Hobolink metadata as an optional thing that can be returned?

Notably, this API should be added to Swagger, and it should also have documentation associated with it. Look into this: https://swagger.io/docs/specification/about/ We are using the OpenAPI specification. It's a bit longwinded and you don't need to read all of it; you will best be served by looking at examples e.g. in the Flasgger README. https://github.com/flasgger/flasgger

@dwreeves dwreeves added data Anything related to databases, data management, stuff that is heavily focused in the data directory. good first issue Good for newcomers labels Aug 19, 2020
@dwreeves
Copy link
Collaborator Author

(Still open)

@dwreeves
Copy link
Collaborator Author

This wouldn't take too long, but I'm not prioritizing this for 2021 boating season. There are already ways to access the raw HOBOlink data. (Well, true raw, not after we clean it up a bit.)

@dwreeves dwreeves added the low priority Issues we are not currently focusing on, either because it has a lot of blockers or isn't important. label Mar 6, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
data Anything related to databases, data management, stuff that is heavily focused in the data directory. good first issue Good for newcomers low priority Issues we are not currently focusing on, either because it has a lot of blockers or isn't important.
Projects
None yet
Development

No branches or pull requests

1 participant