Submitting an open-source project to OSHWA

published November 25, 2020, last updated September 11, 2024

posted in Adafruit Products Maker Business

Beginner

Skill guide

Overview

OSHWA (Open Source Hardware Association) is an organization that, among other things, has created and maintains a process to allow users and companies to certify that their projects are open source. This past spring, many of the boards that Adafruit manufactures were certified. Those certifications were submitted semi-manually, which took quite a while. Now, OSHWA has an API that allows you to submit projects much quicker and can make submitting large numbers of projects at the same time much easier and more straightforward.

In this guide, you'll learn how to submit your open-source project for certification using this API and a Python script. It'll will take you through the process used by Adafruit to submit a project.

Text editor powered by tinymce.

Before you start, you'll need to make an API key that you'll need for use in the script. You can do that here:

OSHWA API token

For the Python code, download the project zip below, and then unzip it in a folder of your choice. Make sure not to run it until you've edited the file to fill out all of the fields with your project's information.

Download Project Bundle

Copy Code

# SPDX-FileCopyrightText: 2020 Eva Herrada for Adafruit Industries
#
# SPDX-License-Identifier: MIT

import requests

token = "TOKEN_GOES_HERE"

url = "https://certificationapi.oshwa.org/api/projects"

responsiblePartyType = "Company"
responsibleParty = "Adafruit Industries, LLC"
bindingParty = "Limor Fried"
country = "United States of America"
streetAddress1 = "150 Varick St."
streetAddress2 = ""
city = "New York"
state = "New York"
postalCode = "10013"
privateContact = "[email protected]"
publicContact = "[email protected]"
projectName = "Adafruit QT Py = SAMD21 Dev Board with STEMMA QT"
projectWebsite = "https://www.adafruit.com/product/4600"
projectVersion = "Rev C"
previousVersions = "[]"
projectDescription = "This diminutive dev board comes with our favorite lil chip, the SAMD21. OLEDs! Inertial Measurement Units! Sensors a-plenty. All plug-and-play thanks to the innovative chainable design: SparkFun Qwiic-compatible STEMMA QT connectors for the I2C bus so you don't even need to solder. It also has 11 GPIO pins and a built-in NeoPixel RGB LED. This board ships with CircuitPython but also works great with Arduino."
primaryType = "Electronics"
additionalType = '[ "Electronics"]'
projectKeywords = f'[ "{projectName}", "CircuitPython"]'
documentationUrl = "https://learn.adafruit.com/adafruit-qt-py"
hardwareLicense = "Other"
softwareLicense = "MIT"
documentationLicense = "CC BY-SA"
relationship = "PROJECT IS DESIGNED AND DISTRIBUTED BY ADAFRUIT INDUSTRIES"

payload = f'{{"responsiblePartyType": "{responsiblePartyType}","responsibleParty": "{responsibleParty}","bindingParty": "{bindingParty}","country": "{country}","streetAddress1": "{streetAddress1}","streetAddress2": "{streetAddress1}","city": "{city}","state": "{state}","postalCode": "{postalCode}","privateContact": "{privateContact}","publicContact": "{publicContact}","projectName": "{projectName}","projectWebsite": "{projectWebsite}","projectVersion": "{projectVersion}","previousVersions": {previousVersions},"projectDescription": "{projectDescription}","primaryType": "{primaryType}","additionalType": {additionalType},"projectKeywords": {projectKeywords},"citations": [{{}}],"documentationUrl": "{documentationUrl}","availableFileFormat": true,"hardwareLicense": "{hardwareLicense}","softwareLicense": "{softwareLicense}","documentationLicense": "{documentationLicense}","noCommercialRestriction": true,"noDocumentationRestriction": true,"openHardwareComponents": "true","creatorContribution": true,"noUseRestriction": true,"redistributedWork": true,"noSpecificProduct": "true","noComponentRestriction": true,"technologyNeutral": true,"certificationMarkTerms": {{ "accurateContactInformation": {{ "term": "I have provided OSHWA with accurate contact information, recognize that all official communications from OSHWA will be directed to that contact information, and will update that contact information as necessary.", "agreement": true }}}},"explanationCertificationTerms": "N/A (I agree to all terms)","relationship": "{relationship}","agreementTerms": true,"parentName": ""}}'
print(payload)

headers = {"Content-Type": "application/json", "Authorization": f"Bearer {token}"}

r = requests.request("POST", url, headers=headers, data=payload)

print("\n")
print(r.status_code)
print("\n")
print(r.json())

# SPDX-FileCopyrightText: 2020 Eva Herrada for Adafruit Industries
#
# SPDX-License-Identifier: MIT

import requests

token = "TOKEN_GOES_HERE"

url = "https://certificationapi.oshwa.org/api/projects"

responsiblePartyType = "Company"
responsibleParty = "Adafruit Industries, LLC"
bindingParty = "Limor Fried"
country = "United States of America"
streetAddress1 = "150 Varick St."
streetAddress2 = ""
city = "New York"
state = "New York"
postalCode = "10013"
privateContact = "[email protected]"
publicContact = "[email protected]"
projectName = "Adafruit QT Py = SAMD21 Dev Board with STEMMA QT"
projectWebsite = "https://www.adafruit.com/product/4600"
projectVersion = "Rev C"
previousVersions = "[]"
projectDescription = "This diminutive dev board comes with our favorite lil chip, the SAMD21. OLEDs! Inertial Measurement Units! Sensors a-plenty. All plug-and-play thanks to the innovative chainable design: SparkFun Qwiic-compatible STEMMA QT connectors for the I2C bus so you don't even need to solder. It also has 11 GPIO pins and a built-in NeoPixel RGB LED. This board ships with CircuitPython but also works great with Arduino."
primaryType = "Electronics"
additionalType = '[ "Electronics"]'
projectKeywords = f'[ "{projectName}", "CircuitPython"]'
documentationUrl = "https://learn.adafruit.com/adafruit-qt-py"
hardwareLicense = "Other"
softwareLicense = "MIT"
documentationLicense = "CC BY-SA"
relationship = "PROJECT IS DESIGNED AND DISTRIBUTED BY ADAFRUIT INDUSTRIES"

payload = f'{{"responsiblePartyType": "{responsiblePartyType}","responsibleParty": "{responsibleParty}","bindingParty": "{bindingParty}","country": "{country}","streetAddress1": "{streetAddress1}","streetAddress2": "{streetAddress1}","city": "{city}","state": "{state}","postalCode": "{postalCode}","privateContact": "{privateContact}","publicContact": "{publicContact}","projectName": "{projectName}","projectWebsite": "{projectWebsite}","projectVersion": "{projectVersion}","previousVersions": {previousVersions},"projectDescription": "{projectDescription}","primaryType": "{primaryType}","additionalType": {additionalType},"projectKeywords": {projectKeywords},"citations": [{{}}],"documentationUrl": "{documentationUrl}","availableFileFormat": true,"hardwareLicense": "{hardwareLicense}","softwareLicense": "{softwareLicense}","documentationLicense": "{documentationLicense}","noCommercialRestriction": true,"noDocumentationRestriction": true,"openHardwareComponents": "true","creatorContribution": true,"noUseRestriction": true,"redistributedWork": true,"noSpecificProduct": "true","noComponentRestriction": true,"technologyNeutral": true,"certificationMarkTerms": {{ "accurateContactInformation": {{ "term": "I have provided OSHWA with accurate contact information, recognize that all official communications from OSHWA will be directed to that contact information, and will update that contact information as necessary.", "agreement": true }}}},"explanationCertificationTerms": "N/A (I agree to all terms)","relationship": "{relationship}","agreementTerms": true,"parentName": ""}}'
print(payload)

headers = {"Content-Type": "application/json", "Authorization": f"Bearer {token}"}

r = requests.request("POST", url, headers=headers, data=payload)

print("\n")
print(r.status_code)
print("\n")
print(r.json())

Then, fill out the variables in the script above. Some are pretty obvious, but some can be slightly more confusing. They're briefly explained below. If you're still uncertain as to the data you need for a field, visit the webpage where you can certify a project and find the field that matches the uncertain variable.

token - The API token you got from the link above.

url - The URL to POST to. Don't change this.

responsiblePartyType - Who this certification is on behalf of, can be "Individual", "Company", or "Organization".

responsibleParty - The name of who or what is responsible for the item being certified.

bindingParty - If responsiblePartyType isn't "Individual", this field should contain the name of the person who is giving permission to OSHWA to certify the project.

country - The country the address you'd like OSHWA to have on file is in.

streetAddress1 - Street address line 1.

streetAddress2 - Street address line 2.

city - City.

state - State.

postalCode - Postal code.

privateContact - The email address you'd like OSHWA to use to contact you.

publicContact - The email address you'd like the public to contact you about your open-source project.

projectName - The name of the project.

projectWebsite - Your project's website.

projectVersion - Your project's current version.

previousVersions - Put the UID for any previously registered versions of the project in this list.

projectDescription - Your project's description. Should be under 500 characters. If you need to put a double quote in here, use the format \\\".

primaryType - Primary project type. See the certification form webpage for more info on possible values.

additionalType - Additional project types, should be formatted similarly to a Python array.

projectKeywords - List of project keywords. Adafruit uses the project name as the first one, although this is by no means necessary.

documentationUrl - URL of the documentation.

hardwareLicense - Hardware license type. Options are "CERN", "Solderpad", "TAPR", and "Other".

softwareLicense - Software license type.

documentationLicense - Documentation license type. Options are "CC 0", "CC BY", "CC BY-SA", and "Other".

relationship - The relationship of the responsibleParty to the project.

After you've filled everything out, you'll want to run the script with python3 submitter.py

adafruit_products_Screenshot_from_2020-11-19_16-59-10.png

If it was successful, you should see a 200 on the second line that gets printed. It should look something like this. If it doesn't look like this, then it is recommended that you read this section of OSHWA's API docs.

Text editor powered by tinymce.