Attribution-NonCommercial 2.0 (CC BY-NC 2.0)https://creativecommons.org/licenses/by-nc/2.0/
License information was derived automatically
Automated weekly collection of CKAN extension metadata from GitHub repositories, tracking development activity, release history, community engagement metrics, and project health indicators.
The categories extension for CKAN aims to enhance dataset organization and discoverability through the introduction of category-based classification. Although the provided documentation is sparse, it implies the addition of a mechanism for categorizing datasets within a CKAN instance, which likely facilitates more intuitive browsing and filtering of available data. This is intended to help users more efficiently find relevant datasets in the catalog. Key Features: Dataset Categorization: The extension allows for the assignment of categories to datasets, providing an additional layer of organization beyond standard CKAN groups and tags. Enhanced Data Discovery: By categorizing datasets, users can potentially browse or filter search results based on category, improving the discoverability of relevant datasets. Configuration Options: Configuration options may exist to customize the categories available for use in the CKAN instance, the readme suggests you may need to configure the plugins. Technical Integration: Based on the installation instructions, the extension integrates with CKAN by adding categories to the ckan.plugins setting in the CKAN configuration file. This activates the extension's functionality within the CKAN instance, making it available for use in dataset management. Likely to also support version 2.9+ of CKAN, assuming its compatible with the plugin architecture. Benefits & Impact: While the documentation lacks specifics, implementing the categories extension promises enhanced dataset discoverability and organization within a CKAN instance. By providing a means to categorize datasets, users can more easily find the data they need, potentially leading to increased data utilization and informed data sharing practices.
ckanext-testext The testext CKAN extension provides a basic framework for extending the functionality of a CKAN instance. While the provided documentation is limited, it serves as a template for developers to create custom extensions, including adding new features, modifying existing behaviors, or integrating with external systems. The extension includes basic scaffolding for installation, configuration, and testing, offering a starting point for building more complex CKAN enhancements. Key Features: Plugin Structure: Offers a basic plugin structure that adheres to CKAN's extension API, allowing developers to hook into core CKAN functionalities and events. Configuration Options: Supports the ability to add custom configuration options, enabling administrators to fine-tune the behavior of the extension through the CKAN configuration file (ckan.ini). Even though currently no settings are provided, its support for them is highlighted . Testing Framework: Includes a rudimentary testing framework, which is useful for developers to systematically test their extensions using pytest after development, ensuring code quality and stability. Packaging and Distribution: Provides instruction for packaging and distributing the extension on PyPI if desired, allowing developers to share their contributions with the broader CKAN community. Version Management: It includes directions for bumping and releasing the extension on GitHub and instructions on where the version number resides, easing the deployment process. Technical Integration: The testext extension integrates with CKAN via the ckan.plugins setting in the CKAN configuration file. By adding testext to this setting, CKAN activates the extension upon startup, allowing it to hook into CKAN's internal events and functionalities. The extension can then utilize CKAN's API to modify its behavior or add new features. Benefits & Impact: The primary benefit of the testext extension is its role as a starter extension, providing developers with a foundation to build upon. By leveraging its basic structure, developers can avoid starting from scratch and focus on implementing the specific features they need. Though functional details are missing, it supports developers in rapidly prototyping and developing custom CKAN features, enhancing data management practices.
Dependency on ckanext-pages: Allows for the creation and management of static content pages within the CKAN instance, providing a way to present information beyond datasets. Custom Configuration: Allows adding optional configurations from the CKAN config file such as the production.ini for use with Apache on Ubuntu. Technical Integration: The extension integrates into CKAN by adding opendatani to the ckan.plugins setting in the CKAN configuration file. This registers the various dependencies and custom behaviors defined by the extension. Benefits & Impact: By integrating multiple extensions, ckanext-opendatani provides Open Data NI with a tailored CKAN instance. This likely streamlines data discovery, improves user engagement through discussions and data requests, ensures data quality through schema validation, and allows for flexible content management via static pages and showcases. This cohesive approach creates a more functional and user-friendly open data portal.
The datitrentinoit extension for CKAN provides customizations tailored specifically for the dati.trentino.it platform. This extension aims to enhance the CKAN installation with region-specific features and functionalities. While the provided documentation is limited, it suggests the extension focuses on adapting CKAN to the unique requirements and context of the dati.trentino.it open data portal. Key Features: Customizations for dati.trentino.it: The primary function is providing alterations and adjustments to the core CKAN system to align with the specific needs of the dati.trentino.it platform. Translation Support: Implements or enhances translation capabilities within the datitrentinoit CKAN installation, enabling localized support via babel and jinja. Translation Management: Includes the ability to extract messages, initialize catalogs, update catalogs, and compile catalogs, which are standard tasks in internationalizing software projects. Technical Integration: The extension is installed as a standard CKAN plugin by including datitrentinoit in the CKAN plugins configuration. This integration point allows the extension to modify CKAN's behavior and appearance to match the dati.trentino.it requirements. It likely involves changes to templates, controllers, or models within CKAN. The readme mentions the project has solved issues with translations, suggesting a deep integration within CKAN’s translation system. Benefits & Impact: The datitrentinoit extension provides a more tailored and user-friendly experience for users of the dati.trentino.it portal. By customizing CKAN, it ensures that the open data platform meets the specific requirements of the Trentino region. Furthermore enhanced translation support also improves accessibility by catering to a multilingual audience.
The ckanext-iota extension enables the synchronization of data from Iota sources into a CKAN instance. Designed to work with [ckanext-harvest], it provides a specific harvester type for importing datasets from Iota data sources, streamlining the process of integrating external data into CKAN. The extension also supports automatically adding harvested datasets to predefined CKAN groups. Key Features: Iota Data Source Integration: Allows CKAN to pull datasets directly from Iota data sources by specifying a URL. Automated Dataset Importing: Facilitates automatic dataset creation in CKAN through the ckanext-harvest framework. Group Assignment Configuration: Enables automatic addition of imported datasets to specified CKAN groups by configuring the Harvest Source. Harvest Source Management: Integrates with the CKAN Harvest interface, allowing users to manage Iota data sources through the standard Harvest Source creation and configuration process. Technical Integration: The extension integrates with CKAN by adding a new harvest source type called "Iota." This requires the ckanext-harvest plugin to be enabled and proper configuration of the ckan.plugins setting in the CKAN configuration file to include both harvest and iota_harvester. Upon installation and configuration, a new "Iota" source type will be available when creating a new Harvest Source. The datasets are automatically imported when the normal ckanext-harvest scheduling kicks off. Benefits & Impact: This Iota integration allows CKAN users to effortlessly incorporate externally managed datasets from Iota sources, which reduces the manual effort needed to maintain up-to-date data from those sources. The automatic group assignment helps to keep CKAN organised.
Apache License, v2.0https://www.apache.org/licenses/LICENSE-2.0
License information was derived automatically
Technical Integration: The ckanext-relation-sddi extension integrates with CKAN as a plugin, hooking into the existing dataset management interface to add relationship management features. To enable the extension, it requires activation in CKAN's configuration file (production.ini) by adding 'relation' to the ckan.plugins setting. A CKAN restart is then necessary for the changes to take effect. Benefits & Impact: By implementing the ckanext-relation-sddiextension, organizations can improve dataset discoverability and contextual understanding, leading to more efficient data utilization and better-informed decision-making. The visual representation of dataset relationships, particularly when combined with ckanext-grouphierarchy-sddi, provides a clear and intuitive way to navigate complex datasets, fostering collaboration and reducing data silos. The designed implementation for HEF, and TUM will aid efficiency and ensure the solution meets the specific data management requirements of the project.
The searchfed extension for CKAN enables federated search across multiple CKAN instances, thereby augmenting the search results displayed to users. If the number of datasets found locally is below a defined threshold, the extension automatically queries external CKAN instances, configured via the ckan.searchfederation setting, and presents those results alongside the local ones. This functionality enhances data discovery by aggregating datasets from different sources into a unified search experience. Key Features: Federated Search: Extends CKAN's search capabilities to include results from external CKAN data portals. The specific URLs of these portals are specified within the CKAN configuration file. Threshold-Based Activation: Only initiates federated search if the number of local search results falls below the value set by ckan.searchfederation.minsearch_results. This avoids unnecessary external queries when local results are sufficient. Configuration-Driven: Uses the ckan.searchfederation setting in the CKAN configuration file to determine which external CKAN instances to query. CKAN Package Search API Integration: Leverages CKAN's existing package search API for querying external data portals ensuring API compatibility and expected functionality. Technical Integration: The searchfed extension integrates with CKAN by adding a plugin configured via the ckan.plugins setting in the CKAN configuration file. It modifies CKAN's search behavior by executing external searches and merging the results based on the configured thresholds. Benefits & Impact: The searchfed extension improves data discoverability within a CKAN ecosystem by supplementing local search results with datasets from other configured data portals. This is particularly beneficial for smaller or more specialized data portals, as it allows them to increase the visibility of their datasets to a wider audience. Furthermore, it streamlines data exploration by presenting users with a single, comprehensive set of search results, eliminating the need to manually query multiple data portals individually.
The ai-assistants extension for CKAN focuses on enhancing data quality and user experience by integrating AI-powered assistance. This extension leverages the OpenAI API to provide automated data quality checks and suggestions, particularly in scenarios where data ingestion via the xloader extension has failed, but can also be enabled for all org admins. It aims to streamline the data curation process and improve the overall reliability of datasets within a CKAN instance. Key Features: AI-Powered Data Quality Assistance: Utilizes the OpenAI API to analyze datasets and provide suggestions for improving data quality or identifying issues. The extension seems to be specifically designed to assist when xloader jobs fail.
Since the documentation is brief and lacks integration details, it can be inferred that this theming extension is integrated with CKAN by overriding default templates and CSS styles. Typically, theme extensions are activated via CKAN’s configuration file and can work with CKAN's plugin system to modify the visual structure of the platform. Benefits & Impact:
The orgportals extension for CKAN enables the creation of organization-specific portals within a CKAN instance. It seems to primarily focus on allowing customization of the CKAN interface to better represent organizations or topics. According to the description, this includes changing text references and potentially customizing templates to align with the specific needs and branding of different organizations or groups. The orgportals extension for CKAN empowers the creation of customized portals tailored to individual organizations or specific topics within a CKAN instance. By enabling flexible configuration options and template overrides, this extension facilitates a more personalized user experience and enhanced organizational branding within the CKAN environment. This enhances the user experience and promotes a more tailored data discovery process. Key Features: Organization/Country Entity Customization: Allows configuration to use "Country/Countries" instead of "Organization/Organizations" within the UI for certain text references, providing a more relevant context for data presentation. Group/Topic entity customization: Enables the configuration to use "Topic/Topics" instead of "Group/Groups" within the UI for certain text references, providing a more relevant context for data presentation. Asset Upload Storage: Provides a configurable storage path for uploading assets related to organizations, ensuring data is organized and accessible. Social Media Integration: Supports integration with Facebook and Twitter by allowing configuration of application IDs and consumer keys for sharing content on social media platforms. Contact Form Email Settings: Offers configuration options for email settings related to a contact form, allowing users to easily reach out for support or inquiries. Customizable Dataset Display: Enables admin to set the number of datasets to display in data section of the portal. Custom Domain Support (with ckanext-orgdashboards): Integrates with the ckanext-orgdashboards extension to provide functionality for adding custom domains to individual dashboards. Language Translation Support: Faciliates language translation through provided mechanisms for creating and compiling language catalogs, which is essential for multi-lingual CKAN instances. Technical Integration: The orgportals extension integrates with CKAN through plugins and utilizes CKAN's i18n framework for language translation. To fully leverage certain features, such as custom domain support, requires installation and configuration of the ckanext-orgdashboards extension. The extension utilizes CKAN's configuration file to define settings and requires implementing the ITranslation interface in the plugin's plugin.py to enable translated strings to be displayed. Benefits & Impact: Implementing the orgportals extension allows organizations to create a more branded and user-friendly CKAN experience. Specifically, the flexibility in configuring entity names to suit organizational or topical contexts makes this extension most useful for those users who want to adapt its usage to their specific environment. The social media integration enables broader outreach and promotion of datasets.
The PublicData.eu (pdeu) extension for CKAN is a custom-built solution designed to tailor CKAN instances for the specific needs of the PublicData.eu portal. This focused extension likely includes modifications and enhancements to CKAN's core functionalities to better support the data publishing and discovery requirements of this specific European open data initiative. While detailed functionality is not explicitly specified, it is designed to optimize user experience and improve data management within the PublicData.eu context. Key Features (assumed based on context): Theme Customization: Provides a unique visual theme aligned with the PublicData.eu branding, ensuring a consistent user experience. Metadata Schema Enhancement: Offers alterations or extension of the dataset metadata schema, to comply with the publicdata.eu metadata fields and standards. Localized Support: Includes multilingual support for content localization, appealing to a broader European audience. Compliance Management: Ensures adherence to European data standards, guidelines, and regulations, facilitating data interoperability and compliance. Portal Integration: Likely integrates with other services and tools used by PublicData.eu for enhanced data management and user experience. Technical Integration: The pdeu extension operates as any other CKAN extension, integrating via plugins and/or extending existing core functionality. Due to a lack of explicit details, details of technical integration cannot be further explained. It is anticipated that this extension customises and adapts the user interface, backend processes, and API interactions according to the specifications of the PublicData.eu requirements. Benefits & Impact: The primary benefit of the pdeu extension is its role in streamlining the setup and management of CKAN for PublicData.eu purposes. This includes visual and experiential benefits through theme customization and also includes functional benefit through optimized metadata schema and localisation improvements relevant to the European context. While the details need to be determined from the source code, the extension offers efficiency gains and targeted functionality relevant to data publishing and data management.
The Transmute extension for CKAN provides a data pipeline for validating and converting data using schemas. It allows users to define schemas that specify validation rules and data transformations, thus ensuring data quality and consistency. The extension enables transformations using an action API with the ability to transform data using defined schemas. Key Features: * Schema-Driven Validation: Uses schemas to define data types, required fields, and validation rules providing the opportunity to validate data against these rules. * Data Transformation: Supports data transformation based on schemas. This includes modifying fields, adding new fields, and removing unnecessary data to fit the desired output format. * Inline Schema Definition: Allows defining schemas directly within the CKAN API calls. This provides a convenient way to apply transformations on-the-fly. * Custom Validators: Supports creation of custom validators, enabling tailored data validation logic. The readme specifically identifies "tsm_concat" as an example of a custom validator. * Field Weighting: Enables control over the order in which fields are processed during validation and transformation, by specifying weight values. * Post-Processing: Provides the option to define steps to execute after processing fields, such as removing fields that are no longer needed after transformation. Technical Integration: The Transmute extension integrates with CKAN by adding a new action API called tsm_transmute
. This API allows users to submit data and a schema, and the extension applies the schema to validate and transform the data. The extension is enabled by adding transmute
to the list of enabled plugins in the CKAN configuration file. Benefits & Impact: Implementing the Transmute extension enhances CKAN's data quality control and transformation capabilities. It provides a flexible and configurable way to ensure data consistency and conformity to defined standards, thus improving the overall reliability and usability of datasets managed within CKAN. Furthermore, it automates the data transformation process using defined schemas, which can reduce the manual workload of data administrators.
The iotrans extension enhances CKAN's capabilities by allowing users to convert datastore resources into various file formats and, for spatial data, transform them between Coordinate Reference Systems (EPSG). This extension addresses the need to download datastore resources in multiple formats and projections beyond CKAN's built-in options, leveraging Python libraries for data conversion. It provides CKAN actions to facilitate file format conversion and data transformation, primarily intended for administrative users. Key Features: Datastore Resource Conversion: Converts CKAN datastore resources to various formats, including CSV, GeoJSON, GPKG, SHP, JSON, and XML. Coordinate Reference System Transformation: Transforms spatial data between different EPSG codes, enabling data compatibility across various GIS applications. Admin-Only Actions: Introduces two CKAN actions, to_file and prune, accessible only to administrator users for file conversion and temporary file cleanup. Disk-Based Processing: Streams data from the CKAN datastore to a temporary CSV file, reducing memory consumption during format conversion. Spatial Data Handling: Identifies spatial data based on the presence of a "geometry" attribute and converts non-Multi geometry types to their Multi counterparts (e.g., Point to MultiPoint) to ensure consistent geometry types within output files. Shapefile Support: Handles shapefile-specific limitations by truncating column names longer than 10 characters, creating unique column names, and documenting the original-to-truncated name mapping in a zipped text file within the shapefile. Temporary File Management: Uses the /tmp directory as a staging area for file conversions, with a prune action to remove files or directories within this location. Technical Integration: The iotrans extension functions by adding new API actions to CKAN (to_file and prune). These actions interact directly with the CKAN datastore extension, retrieving data in chunks via sequential calls to CKAN's datastore_search API, converting it to different formats, and storing these in the /tmp directory. It requires the CKAN Datastore extension to be active. Benefits & Impact: The iotrans extension streamlines the process of extracting and transforming data from the CKAN datastore, enabling users to easily access data in preferred formats and coordinate reference systems. This enhances data usability and interoperability, making it easier to integrate CKAN data into other applications and workflows. It is especially useful for organizations that need to provide data in various formats to meet diverse user needs.
The Versioning extension for CKAN provides a fundamental data versioning capability, enabling the tracking of changes to both metadata and data over time. This extension creates new revisions upon each update, ensuring access to historical data versions. Furthermore, it introduces the concept of releases, allowing users to label specific revisions and associate them with descriptions, similar to tags in version control systems. Key Features: Data and Metadata Revisioning: All dataset updates create new revisions, making past versions accessible. This ensures no data is lost and users can revert to earlier states if necessary. Releases Management: Create and manage releases, which are named labels and descriptions for specific dataset revisions (akin to VCS tags), enabling users to mark stable or significant versions of a dataset (e.g., "v1.0"). Dataset Releases List: Allows you to list all available releases for a specific dataset, enabling easy access and management of different versions. Dataset Releases Show: Displays detailed information about a specific dataset release, including its unique identifier and associated metadata, thus facilitating easy identification and access of data. Dataset Release Creation: Enables creating new releases by providing a dataset identifier, a unique name, and an optional description, thus enabling controlled versioning management. Dataset Release Deletion: Capable of deleting existing releases without affecting the underlying dataset revisions, thus promoting a flexible approach to versioning. Packageshowrelease Action: Using this action, it is possible to retrieve dataset metadata for a specific release, which is similar to the built-in 'package_show' action, but adds versioning related metadata. Technical Integration: The Versioning extension introduces new API actions within CKAN that facilitate the management and utilization of dataset revisions and releases. These API endpoints, such as datasetreleaselist, datasetreleaseshow, datasetreleasecreate, datasetreleasedelete, and packageshowrelease, integrate directly into the CKAN REST API. The extension also requires specific configuration settings in the CKAN INI file, namely ckanext.versioning.backend_type and ckanext.versioning.backend_config, to define the metastore-lib backend and its associated configurations. The extension relies on metastore-lib for handling the underlying storage. Benefits & Impact: Implementing the Versioning extension enables robust tracking of data changes in CKAN, preventing data loss and aiding in data governance. The release feature lets you designate specific versions for reference and sharing. By providing a comprehensive versioning system, it can improve data governance, enhance data quality, and support reproducibility in data-driven research or decision-making.
Dependencies Management: Requires a CKAN installation within the same virtual environment, following CKAN’s standard plugin system. Technical Integration: The ckanext-dgutheme extension integrates directly into CKAN by specifying it as a plugin within the CKAN configuration file (typically a .ini file). The extension hooks into CKAN's theming system, likely overriding default templates and CSS with those specific to the data.gov.uk design. Activation involves adding the extension's name to the [app:main] section's plugin list, ensuring CKAN loads and applies the theme. Benefits & Impact: This extension is valuable for organizations seeking to create a CKAN instance that mirrors the user experience of data.gov.uk. This visual consistency might be important for user familiarity, branding purposes, or specific project requirements. By using the ckanext-dgutheme, users can quickly apply a recognizable theme without extensive custom development.
The openAFRICA CKAN extension provides a theme designed specifically for the openAFRICA platform. As a theming extension, it modifies the appearance of a CKAN instance to align with the openAFRICA brand and potentially override default CKAN templates or those from other extensions. It aims to create a visually consistent and user-friendly experience for visitors accessing open data on the African continent. Key Features: openAFRICA Theming: Offers a pre-built theme to visually transform a CKAN instance to match the openAFRICA platform's design, providing a consistent user interface. Template Overriding: The extension's templates can override existing CKAN templates, allowing for customization of various aspects, including but not limited to dataset pages, search results, and organization pages. Note that modifications may be required to ensure proper rendering and compatibility with other extensions. Configuration Integration: As a plugin that customizes the look and feel of a CKAN instance, the openAFRICA theme is activated through a simple addition to the ckan.plugins configuration option. Technical Integration: The extension is installed into a CKAN virtual environment and enabled via the CKAN configuration file (production.ini). Activating the openafrica plugin in the ckan.plugins setting applies the openAFRICA theme to the CKAN instance. The readme mentions that restarting the CKAN server is necessary for the changes to take effect, and provides options for restarting the server with and without automatic reloading on code changes. Benefits & Impact: The openAFRICA extension streamlines the process of branding a CKAN instance to align with the openAFRICA project. This simplifies visual data presentation, contributing to increased user engagement. By providing a pre-designed theme, it eliminates the need for manual design and coding efforts, saving both time and resources. This theming support promotes a unified experience for data users, leading to a more accessible and intuitive platform.
The extension integrates with CKAN by providing custom plugins or modules that modify CKAN's behavior. As part of the installation process, specific extensions are installed ensuring that the data portal is configured in a systematic manner. It is implied that additional settings can be configured within CKAN's configuration files to meet particular integration parameters. Benefits & Impact: By customizing CKAN, ckanext-dataportal enhances the usability and relevance of the ILRI Data Portal, enabling more efficient data management and dissemination of research outputs. Improved data discoverability for researchers is achieved through the custom metadata fields, ensuring better visibility of relevant information. The automation brought about by MySQL integration improves the efficiency of data handling and mitigates manual efforts, while the enhanced functionalities better meet user needs, potentially attracting more traffic and fostering collaboration through centralized data access.
The Tour extension for CKAN provides the capability to create interactive guided tours within a CKAN instance. This extension focuses on enhancing the user experience by walking users through different features and functionalities, making it easier for them to understand and utilize the CKAN portal effectively. It is particularly useful for onboarding new users or highlighting specific aspects of a CKAN implementation. Key Features: Interactive Guided Tours: Develop step-by-step tours that guide users through various features of a CKAN instance, helping them understand how to use the platform. Element Highlighting: Call attention to specific elements on CKAN pages, allowing tour creators to focus user attention on key parts of the interface and ensure greater clarity.
The Scheming extension integrates deeply with CKAN's data model and form rendering process. It uses configuration settings (e.g., scheming.datasetschemas) to load schemas, which then modify the behavior of CKAN's dataset, group, and organization forms. It provides action API endpoints to access to expose defined schemas. Additionally, the extension leverages CKAN's plugin system and templating engine to allow administrators the ability to extend and customize forms and display snippets. Benefits & Impact: By implementing the Scheming extension, organizations can enforce standardized metadata practices across their CKAN instances. This leads to improved data quality, better discoverability, and enhanced data governance. It also reduces the effort required to customize CKAN for specific data requirements, ultimately making the platform more flexible, robust, and user-friendly.
Attribution-NonCommercial 2.0 (CC BY-NC 2.0)https://creativecommons.org/licenses/by-nc/2.0/
License information was derived automatically
Automated weekly collection of CKAN extension metadata from GitHub repositories, tracking development activity, release history, community engagement metrics, and project health indicators.