Merge pull request #131 from CSCfi/develop

Release 0.5.3

.github/workflows/int.yml

@@ -22,7 +22,7 @@ jobs:
         python-version: ${{ matrix.python-version }}
     - name: Install requirements
       run: |
-         pip install aiohttp aiofiles
+         pip install aiohttp aiofiles motor
         
     - name: Start Services
       run: |

.gitignore

@@ -66,6 +66,10 @@ instance/
 
 # Sphinx documentation
 docs/_build/
+docs/metadata_backend.api/
+docs/metadata_backend.helpers/
+docs/metadata_backend.conf/
+docs/metadata_backend.database/
 
 # PyBuilder
 target/

docs/_static/style.css

@@ -1 +1,16 @@
-/* Custom styles */
+/* Custom styles */
+.wy-nav-content {max-width: 1000px;}
+
+/* override table width restrictions */
+@media screen and (min-width: 767px) {
+
+    .wy-table-responsive table td {
+       /* !important prevents the common CSS stylesheets from overriding
+          this as on RTD they are loaded after this stylesheet */
+       white-space: normal !important;
+    }
+
+    .wy-table-responsive {
+       overflow: visible !important;
+    }
+ }

docs/code.rst

@@ -0,0 +1,76 @@
+------------------------
+Metadata Backend Modules
+------------------------
+
+.. automodule:: metadata_backend
+   :synopsis: The metadata_backend package contains code for Beacon API.
+
+.. autosummary::
+
+    metadata_backend.api
+    metadata_backend.conf
+    metadata_backend.database
+    metadata_backend.helpers
+    metadata_backend.server
+
+
+********************
+Metadata Backend API
+********************
+
+.. automodule:: metadata_backend.api
+
+.. autosummary::
+   :toctree: metadata_backend.api
+
+    metadata_backend.api.handlers
+    metadata_backend.api.middlewares
+    metadata_backend.api.operators
+
+*******************
+Database Operations
+*******************
+
+.. automodule:: metadata_backend.database
+
+.. autosummary::
+   :toctree: metadata_backend.database
+
+    metadata_backend.database.db_service
+
+*****************
+Utility Functions
+*****************
+
+.. automodule:: metadata_backend.helpers
+
+.. autosummary::
+   :toctree: metadata_backend.helpers
+
+    metadata_backend.helpers.logger
+    metadata_backend.helpers.parser
+    metadata_backend.helpers.schema_loader
+    metadata_backend.helpers.validator
+
+*************
+Configuration
+*************
+
+.. automodule:: metadata_backend.conf
+
+
+.. autosummary::
+   :toctree: metadata_backend.conf
+
+
+   metadata_backend.conf.conf
+
+******
+Server
+******
+
+.. automodule:: metadata_backend.server
+    :members:
+
+
+:ref:`genindex` | :ref:`modindex`

docs/conf.py

@@ -11,7 +11,7 @@
 author = "CSC Developers"
 
 # The full version, including alpha/beta/rc tags
-release = "0.5.2"
+release = "0.5.3"
 
 
 # -- General configuration ---------------------------------------------------
@@ -64,7 +64,7 @@
 
 def setup(app: Callable) -> None:
     """Add custom stylesheet."""
-    app.add_css_file("custom.css")
+    app.add_css_file("style.css")
 
 
 htmlhelp_basename = "metadata-submitter"

docs/index.rst

@@ -6,11 +6,16 @@
 CSC Metadata Submitter
 ======================
 
+Metadata submission service to handle submissions of EGA metadata, either as XML files or via form submissions. Submissions through graphical frontend and POST are supported.
+Service also validates submitted metadata objects against EGA XSD metadata models and saves objects to database.
+
 .. toctree::
    :maxdepth: 2
    :caption: Contents:
 
-   validator
+   Metadata Submitter <submitter>
+   Metadata Validator Tool <validator>
+   Metadata Backend Modules <code>
 
 
 Indices and tables