dserver-search-plugin-mongo

Search plugin for dtool-lookup-server using mongodb

https://github.com/jic-dtool/dserver-search-plugin-mongo

Science Score: 67.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
    Found 1 DOI reference(s) in README
  • Academic publication links
    Links to: zenodo.org
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (8.7%) to scientific vocabulary
Last synced: 10 months ago · JSON representation ·

Repository

Search plugin for dtool-lookup-server using mongodb

Basic Info
  • Host: GitHub
  • Owner: jic-dtool
  • License: mit
  • Language: Python
  • Default Branch: main
  • Size: 79.1 KB
Statistics
  • Stars: 0
  • Watchers: 2
  • Forks: 2
  • Open Issues: 5
  • Releases: 1
Created over 3 years ago · Last pushed almost 2 years ago
Metadata Files
Readme Changelog License Citation

README.rst

dserver Search Plugin Mongo
===========================

.. |dtool| image:: https://github.com/jic-dtool/dserver-search-plugin-mongo/blob/main/icons/22x22/dtool_logo.png?raw=True
    :height: 20px
    :target: https://github.com/jic-dtool/dserver-search-plugin-mongo
.. |pypi| image:: https://img.shields.io/pypi/v/dserver-search-plugin-mongo
    :target: https://pypi.org/project/dserver-search-plugin-mongo/
.. |tag| image:: https://img.shields.io/github/v/tag/jic-dtool/dserver-search-plugin-mongo
    :target: https://github.com/jic-dtool/dserver-search-plugin-mongo/tags
.. |test| image:: https://img.shields.io/github/actions/workflow/status/jic-dtool/dserver-search-plugin-mongo/test.yml?branch=main&label=tests
    :target: https://github.com/jic-dtool/dserver-search-plugin-mongo/actions/workflows/test.yml
.. |zenodo| image:: https://zenodo.org/badge/562489144.svg
    :target: https://zenodo.org/doi/10.5281/zenodo.12702153

|dtool| |pypi| |tag| |test| |zenodo|

Search plugin for *dserver* using mongodb

To install the ``dserver-search-plugin-mongo`` package.

.. code-block:: bash

    cd dserver-search-plugin-mongo
    pip install .

To configure the connection to the mongo database.

.. code-block:: bash

    export SEARCH_MONGO_URI="mongodb://localhost:27017/"
    export SEARCH_MONGO_DB="dserver"
    export SEARCH_MONGO_COLLECTION="datasets"

Testing
^^^^^^^

Testing requires a minimal ``dserver`` installation including a
functional retrieve plugin, i.e.

.. code-block:: bash

    pip install dservercore
    pip install dserver-retrieve-plugin-mongo

Installation with the ``[test]`` extension

.. code-block:: bash

    pip install .[test]

installs these essential testing dependencies as well.

Run tests from within repository root with ``pytest``.

Owner

  • Name: dtool
  • Login: jic-dtool
  • Kind: organization

Citation (CITATION.cff)

cff-version: 1.2.0
authors:
- family-names: Hörmann
  given-names: Johannes L.
  orcid: 0000-0001-5867-695X
- family-names: Olsson
  given-names: Tjelvar S. G.
  orcid:  0000-0001-8791-4531
title: dserver-search-plugin-mongo

GitHub Events

Total
Last Year

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 21 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 0
  • Total versions: 4
  • Total maintainers: 2
pypi.org: dserver-search-plugin-mongo

Search plugin for dserver using mongodb

  • Versions: 4
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 21 Last month
Rankings
Dependent packages count: 10.8%
Average: 35.9%
Dependent repos count: 60.9%
Maintainers (2)
Last synced: 10 months ago

Dependencies

.github/workflows/test.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
  • supercharge/mongodb-github-action 1.8.0 composite
pyproject.toml pypi
  • dtool-lookup-server *
  • dtoolcore >=3.18.0
  • pymongo *
requirements.txt pypi