Taxonomy
The taxonomy service is a library that can be installed in other edX components that provides access to third party taxonomy vendors. EMSI is currently the only vendor available, but others may be integrated as necessary. This service can communicate with the vendor to get job, skill, and salary data. This service can also be used to submit data (course descriptions, etc.) to the vendor to produce potential matches for a skill or job.
After submitting a pull request, please use the Github “Reviewers” widget to add relevant reviewers and track review process.
Getting Started
To install taxonomy-connector, for example, in Course Discovery, follow these steps:
It is recommended that you clone this repo into a sub-folder of your working directory. Create a sub-folder with name src if it doesn’t already exist.
Clone this repository into the src folder.
Go to the shell of the host environment where you want to install this package and run this pip install -e /edx/src/taxonomy-connector
Changes made into the taxonomy repository will now be picked up by your host environment.
Notes:
In order to communicate with EMSI service, you need to set the values of client_id and client_secret. These values are picked up from the host environment so you need to pass them in .yaml file of the host environment.
Also, to make taxonomy work, the host platform must add an implementation of data providers written in ./taxonomy/providers
Taxonomy APIs use throttle rate set in DEFAULT_THROTTLE_RATES settings by default. Custom Throttle rate can by set by adding ScopedRateThrottle class in DEFAULT_THROTTLE_CLASSES settings and taxonomy-api-throttle-scope key in DEFAULT_THROTTLE_RATES
For the skill tags to be verified, the management command finalize_xblockskill_tags needs to be run periodically.
Also, You can configure the skill tags verification by setting the values of SKILLS_VERIFICATION_THRESHOLD, SKILLS_VERIFICATION_RATIO_THRESHOLD, SKILLS_IGNORED_THRESHOLD and SKILLS_IGNORED_RATIO_THRESHOLD in the host platform or by passing the values to the command using the args --min-verified-votes, --ratio-verified-threshold, --min-ignored-votes and --ratio-ignored-threshold.
REST_FRAMEWORK = {
'DEFAULT_THROTTLE_CLASSES': (
'rest_framework.throttling.UserRateThrottle',
'rest_framework.throttling.ScopedRateThrottle'
),
'DEFAULT_THROTTLE_RATES': {
'user': '100/hour',
'taxonomy-api-throttle-scope': '60/min', # custom throttle rate for taxonomy api
},
}Developer Notes
To run unit tests, create a virtualenv, install the requirements with make requirements and then run make test
To update the requirements, run make upgrade
To run quality checks, run make quality
Please do not import models directly in course discovery. e:g if you want to import CourseSkills in Discovery, use the utility get_whitelisted_course_skills instead of directly importing it.
Reporting Security Issues
Please do not report security issues in public. Please email security@openedx.org.
Getting Help
Have a question about this repository, or about Open edX in general? Please refer to this list of resources if you need any assistance.
1 maintainer
Metadata
1 maintainer
Release files for taxonomy-connector 4.1.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| taxonomy_connector-4.1.0.tar.gz | 517.5 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| taxonomy_connector-4.1.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 651.7 kB
Release files / taxonomy_connector-4.1.0.tar.gz
| Download URL | taxonomy_connector-4.1.0.tar.gz |
|---|---|
| Size | 517.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
355473239bb1822362295f58ab7dbf4582c2e7f86cc6e5c82de5aa085a37be95
|
|
BLAKE2b-256 checksum How to use checksums |
9cfd0566b45f3053cdf161dcaf1814e810f76e24bdaee816335365bd0f3e293b
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 29, 2026.
Transparency logRelease files / taxonomy_connector-4.1.0-py3-none-any.whl
| Download URL | taxonomy_connector-4.1.0-py3-none-any.whl |
|---|---|
| Size | 134.1 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
24ef7a11f146ab88b3af5863648c0f7ad3d78f71f469e070794601b1d364fc14
|
|
BLAKE2b-256 checksum How to use checksums |
8d2fab70593de6e43f0d83f9ffafedc9b4fef25ca8331a15ddb51c6a556b5c38
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 29, 2026.
Transparency log
