khaeru / dsss

A dead-simple SDMX server

dsss: a dead-simple SDMX server

A rudimentary implementation of the SDMX REST web service standard.

This code is developed mainly as an aid for prototyping and testing other code that generates SDMX or relies on SDMX REST web services being available. It is not currently intended and likely not ready for production use.

Implementation

The package depends only on:

• sdmx1 —for the SDMX Information Model, file formats, URLs, URNs, and more.
• starlette —as a base web service framework.

It provides a Store class and subclasses for storing the structures and data to be served by an instance.

License

Copyright 2014–2024, dsss developers

Licensed under the GNU Affero General Public License, Version 3.0 (the “License”); you may not use these files except in compliance with the License. You may obtain a copy of the License:

• from the file LICENSE included with the source code, or
• at https://www.gnu.org/licenses/agpl-3.0.en.html

dsss's Issues

Add basic authorization using API keys

For #6, a first/naive implementation would simply accept and process any POST request.

To extend, add authorization. The simplest possible form would likely involve:

• API keys/tokens generated with secrets.token_urlsafe()
• …stored in a new field on the Config class.
• …added in various ways:
  • Through a environment variable/CLI option when starting the server.
  • Read from a file.
  • etc.
• Only binary authorization, i.e. not fine-grained.

(More sophisticated ways could involve the 'root' admin doing SDMX-REST POST to indicate authorizations and tokens associated as SDMX annotations of Contacts associated with particular Agencies in an AgencyScheme.)

Implement draft REST standards for `POST` requests

Per the document “Applying the HTTP methods to the SDMX REST API for Structural Metadata maintenance” in the SDMX-REST repository:

The following sections describe the foreseen HTTP methods for the maintenance of SDMX Structural Metadata via the REST API.

Add ‘sdmx’ Topic: Boost Discoverability for SDMX Repositories

Dear repository owners, 🌟

As your repository is related to SDMX (Statistical Data and Metadata Exchange), please consider adding the sdmx topic to it. This will help other developers discover and engage with your project more easily.

To associate your repository with the sdmx topic, visit your repo's landing page and select 'manage topics'. Let's make SDMX-related projects more visible and accessible! 🚀

Thank you for contributing to the community! 🙌

For detailed instructions on how to add topics to your repository, refer to the GitHub documentation.

Happy coding! 🌐👩‍💻👨‍💻