uData is customizable in many ways, just choose yours.
Before trying to code something specific, take a look at all the settings, there may already be some details you can easily customize with a simple setting.
You can totally customize the udata appearence with themes.
See the dedicated section for more details.
NB: A theme is also an entrypoint, but a special one.
Entrypoints are modules or classes loaded by udata to extends its features.
Plugins can expose extra harvesters via the
udata.harvesters class entrypoint.
See the Harvesting section for more details
Plugins can expose extra view features via the
udata.views module entrypoint including:
- a blueprint (should be named
- some view filters
A module entrypoint allowing to register new metrics.
This module entrypoint allows you to expose new models or to extend existing ones by adding new badges or new known extras.
Models entrypoints may also expose migrations in the
migrations folder sibling to the
If you only need to expose migrations, just provide an empty
Link checkers (
This class entrypoint allows to register new link checkers that udata will recognize and use.
Tasks and jobs (
This module entrypoint allows to register new asynchronous tasks and schedulable jobs.
A class entrypoint for preview providers.
These plugins should extend
from udata.core.dataset.preview import PreviewPlugin class MyPreview(PreviewPlugin): def can_preview(self, resource): # Check whether or not you can display a preview # You can access the resource or its dataset (through resource.dataset) # to check your requirements def preview_url(self, resource): # Return the absolute preview URL for the given resource. # You can access the resource or its dataset (through resource.dataset) # to build your preview URL
You can mark a preview plugin as
fallback, meaning it will only be a candidate
if other plugins can’t provide a preview.
This is typically for plugin displaying generic preview (ie. only relying on mimetype for example):
from udata.core.dataset.preview import PreviewPlugin class MyGenericPreview(PreviewPlugin): fallback = True
Enabled plugins are cached so don’t forget to flush cache when:
- you change your
- you deliver new plugin versions
Generic plugins (
A module entrypoint for generic plugins. They just have to expose a
and can perform any manual initialization.
Use this entrypoint if you want to perform something not handled by previous entrypoints.
Any registered plugin may also expose translations in its root module
They will be automatically discovered and loaded if the plugin is enabled.
Last but not least, if none of the above match your needs, you can also contribute to the core udata project and submit some contributions.