-
Notifications
You must be signed in to change notification settings - Fork 8
Updater API documentation (v2)
Welcome to the PyWeather Updater API version 2 documentation.
The PyWeather Updater API is designed to be a future-proof, extensive information system that allows for future branches and more information later down the line, all while maintaining compatibility with any API version.
- v2.0.1 - Added md5, sha1, and sha256 sums
- v2.0 - Initial release
The info section stores information about the API.
apiversion: Shows the API version (type: str, 2.0+)
documentation: Shows the documentation URL for the API. (type: str, 2.0+)
This is the starting section of the different release branches, stable and RC.
This section stores information about the stable release branch of PyWeather.
latestbuild: The latest build number (type: int, 2.0+)
latestversion: The latest version in text format (type: str, 2.0+)
latestversiontag: The latest version in Git tag format (type: str, 2.0+)
latesturl: The download URL for the latest version in the stable branch (type: str, 2.0+)
latestfilename: The filename of the .zip for the latest version in the stable branch (type: str, 2.0+)
extractdirectory: The directory that the contents of PyWeather are stored in the latest .zip. (type: str, 2.0+)
releasedate: The release date of the latest stable version (type: str, 2.0+)
size: The size of the .zip file of the latest version (type: str, 2.0+)
releasenotesurl: The URL of the release notes for the latest stable version (type: str, 2.0+)
md5sum: The MD5 sum for the stable .zip (type: str, 2.0.1+)
sha1sum: The SHA-1 sum for the stable .zip (type: str, 2.0.1+)
sha256sum: The SHA-256 sum for the stable .zip (type: str, 2.0.1+)
This section stores information about the rc release branch of PyWeather.
rcrelease: Indicates if the release info stated in ['branch']['rc'] is an rc build (type: boolean, 2.0+)
stablerelease: Indicates if the release info stated in ['branch']['rc'] is a stable build (type: boolean, 2.0+)
latestbuild: The latest build number (type: float, 2.0+)
latestversion: The latest version in text format (type: str, 2.0+)
latestversiontag: The latest version in Git tag format (type: str, 2.0+)
latesturl: The download URL for the latest version in the rc branch (type: str, 2.0+)
latestfilename: The filename of the .zip for the latest version in the rc branch (type: str, 2.0+)
extractdirectory: The directory that the contents of PyWeather are stored in the latest .zip. (type: str, 2.0+)
releasedate: The release date of the latest rc version (type: str, 2.0+)
size: The size of the .zip file of the latest version (type: str, 2.0+)
releasenotesurl: The URL of the release notes for the latest rc version (type: str, 2.0+)
md5sum: The MD5 sum for the rc .zip (type: str, 2.0.1+)
sha1sum: The SHA-1 sum for the rc .zip (type: str, 2.0.1+)
sha256sum: The SHA-256 sum for the rc .zip (type: str, 2.0.1+)