Skip to content

Commit

Permalink
Mirror README contents in doc/index
Browse files Browse the repository at this point in the history
  • Loading branch information
khaeru committed Jul 9, 2024
1 parent eee1920 commit 9478450
Showing 1 changed file with 48 additions and 4 deletions.
52 changes: 48 additions & 4 deletions doc/index.rst
Original file line number Diff line number Diff line change
@@ -1,9 +1,41 @@
DSSS: a dead-simple SDMX server
*******************************

.. image:: https://img.shields.io/pypi/v/dsss.svg
:target: https://pypi.org/project/dsss
:alt: PyPI version badge
.. image:: https://readthedocs.org/projects/dsss/badge/?version=latest
:target: https://dsss.readthedocs.io/en/latest
:alt: Documentation status badge
.. image:: https://codecov.io/gh/khaeru/dsss/graph/badge.svg?token=IL5RTND3E7
:target: https://codecov.io/gh/khaeru/dsss
:alt: Codecov test coverage badge
.. image:: https://github.com/khaeru/dsss/actions/workflows/pytest.yaml/badge.svg
:target: https://github.com/khaeru/dsss/actions/workflows/pytest.yaml
:alt: Status badge for the "pytest" continuous testing workflow

A rudimentary implementation of the `SDMX REST web service <https://github.com/sdmx-twg/sdmx-rest>`_ standard.

This package 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.

The package depends only on:

- `sdmx1 <https://github.com/khaeru/sdmx>`_ —for the SDMX Information Model, file formats, URLs, URNs, and more.
- `starlette <https://www.starlette.io>`_ —as a base web service framework.

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

On this page:

.. contents::
:local:
:backlinks: none

On other pages:

.. toctree::
:maxdepth: 2
:caption: Contents:
:maxdepth: 1

usage
api
Expand All @@ -14,10 +46,22 @@ Roadmap

After 1.0, some features that will likely be added include:

- Provide complete documentation.
- Provide complete documentation, including for cloud deployment.
- Provide a complete test suite.
- Provide logging.
- Support all maintained Python versions, macOS, and Windows.
- Support additional maintained Python versions, macOS, and Windows.

License
=======

Copyright 2014–2024, `dsss developers <https://github.com/khaeru/dsss/graphs/contributors>`_

Licensed under the GNU 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/gpl-3.0.en.html


Indices and tables
==================
Expand Down

0 comments on commit 9478450

Please sign in to comment.