jyksnw / yv-api-python Goto Github PK

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

Describe the solution you'd like
A simple contributing guideline that aids new developers in contributing to the project. Possibly adapt from an existing guideline.

Describe alternatives you've considered
N/A

Additional context
A Contributing Guideline helps guide developers with contributing to the project. It outlines basic workflows and rules around getting setup with the project and how to submit a pull request.

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

Describe the solution you'd like
Codacy does quality checks on markdown files using remark, remark can be used locally or through CI to help lint and fix markdown style issues. This will ensure that all markdown files are in a uniform style and have maximum compatibility.

Describe alternatives you've considered
No other alternatives have been considered since Codacy uses remark.

Additional context
N/A

Describe the solution you'd like
The YouVersion API Docs outlines a way to fetch multiple verse of the day objects.

Describe the bug
There is no bounds checking happening on the inbound day variable which would allow for someone to request a day over day 366 and would result in an API error.

To Reproduce
Steps to reproduce the behavior:

1. yv.get_verse_of_the_day(400)

Expected behavior
A value below 1 and over 366 should throw an error before the request ever reaches the wire

Additional context
An HTTPError would more than likely be raised but it would be good to catch the error before sending the request over the wire since that could be an expensive call (in terms of time and bandwidth).

Describe the bug
The test test_image_download_provided_path doesn't actually test that the downloaded file is found at the provided path.

Expected behavior
test_image_download_provided_path confirms that the image is downloaded and saved to the provided path