https://github.com/nvaccess/addon-datastore-validation

Validation code to check NVDA-addon metadata.
https://github.com/nvaccess/addon-datastore-validation

Last synced: about 2 months ago
JSON representation

Validation code to check NVDA-addon metadata.

• Host: GitHub
• URL: https://github.com/nvaccess/addon-datastore-validation
• Owner: nvaccess
• License: gpl-3.0
• Created: 2021-02-17T08:55:52.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2024-09-17T23:24:13.000Z (4 months ago)
• Last Synced: 2024-09-18T03:46:31.579Z (4 months ago)
• Language: Python
• Size: 336 KB
• Stars: 1
• Watchers: 7
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Validate NVDA add-on metadata ##

This is a "GitHub Action" repository.

The Action aims to validate the metadata of add-ons submitted to

[NVDA's add-on store](https://github.com/nvaccess/addon-datastore).

- Check that the added metadata:

  - Conforms with the

  [addonVersion_schema.json file](https://github.com/nvaccess/addon-datastore-validation/blob/main/_validate/addonVersion_schema.json).

  - File has the correct path and name: `addon1/majorVersion.minorVersion.patch.json`

  - Download URL is valid:

    - Must start with "https://" and end with".nvda-addon"

    - The `*.nvda-addon` file can be downloaded

  - The Sha256 of the downloaded `*.nvda-addon` file matches.

- Check data matches the addon's manifest file.

  - The manifest exists in the downloaded `*.nvda-addon` file and can be loaded by the `AddonManifest` class. 

  - The submission addonName matches the manifest summary field

  - The submission description matches the manifest description field

  - The homepage URL matches the manifest URL field

  - The addon versions match

  - The last tested & minimum required versions are valid NVDA API versions.

If all is valid, "Congratulations: manifest, metadata and file path are valid" is printed.

## Dependencies ##

* [Python](https://www.python.org/).

  - Tested with: 3.8, 32 bit

## Local Usage ##

To try validating an addon submission on your own machine.

From cmd.exe:

1. Clone this repo: `git clone https://github.com/nvaccess/addon-datastore-validation.git`

1. From the repo folder, run: `runvalidate  `

## Run unit tests:

To test the scripts used in this action, you can run the unit tests.

1. Install [tox](https://pypi.org/project/tox): `pip install tox`

1. `tox`

## Python linting:

To keep a consistent style within the Python files of this Action, linting is used:

1. Use cmd.exe

1. `cd` to the repo folder

1. `runlint`

## Calculate a hash (sha256)

To get the sha256 of a file:

1. Use cmd.exe

1. `runsha `