feeds-lunr

This is an experiment in using Lunr Python and LunrJS for search of feeds.library.caltech.edu content

https://github.com/caltechlibrary/feeds-lunr

Science Score: 26.0%

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

○
CITATION.cff file
✓
codemeta.json file
Found codemeta.json file
✓
.zenodo.json file
Found .zenodo.json file
○
DOI references
○
Academic publication links
○
Academic email domains
○
Institutional organization owner
○
JOSS paper metadata
○
Scientific vocabulary similarity
Low similarity (12.8%) to scientific vocabulary

Last synced: 10 months ago · JSON representation

Repository

This is an experiment in using Lunr Python and LunrJS for search of feeds.library.caltech.edu content

Basic Info

Host: GitHub
Owner: caltechlibrary
License: other
Language: HTML
Default Branch: master
Size: 49.8 KB

Statistics

Stars: 0
Watchers: 6
Forks: 0
Open Issues: 0
Releases: 0

Created over 6 years ago · Last pushed over 6 years ago

Metadata Files

Readme Changelog Contributing License Code of conduct Codemeta

Template for software repositories by the Caltech Library

This is a template README file for software repositories. This first paragraph of the README should summarize your software in a concise fashion, preferably using no more than one or two sentences.

Introduction
Installation
Usage
Known issues and limitations
Getting help
Contributing
License
Authors and history
Acknowledgments

Introduction

feeds-lunr is an experimental implementation of search of feeds.library.caltech.edu based on Python Lunr and LunrJS.

Installation

Pre-requisites:

Bash
Curl
dataset
datatools
mkpage
Python 3
Lunr
py_dataset
A web browser

Steps to setup and run this demo.

Clone this repository and change directory to it
Run ./setup.bash to fetch our dataset collections
Run make to build the demo
Run ws htdocs to start a localhost web server
Point you web browser at the localhost web server and try it out

Bash git clone https://github.com/caltechlibrary/feeds-lunr cd feeds-lunr ./setup-demo.bash make ws htdocs

Usage

Usage setup and run the local web service as described in the installation section. Point your web browser at the URL where the web service is running.

If you've successfully installed everything

Bash make ws htdocs

Known issues and limitations

This is an experiment. It is not intended as production software only as an implementation to explore how Lunr/LunrJS may or may not be useful to Caltech Library to address some of the limitations of the native searches supplied with solfware such as EPrints, Invenio, and ArchivesSpace.

Getting help

See the GitHub issue tracker for this project.

Contributing

Feel free to fork this project and experiment too per license.

License

Authors and history

Repository created 2019-10-08 to explore indexing setup and options for content hosted at feeds.library.caltech.edu.

Authors:

R. S. Doiel

Acknowledgments

This work was funded by the California Institute of Technology Library.

(If this work was also supported by other organizations, acknowledge them here. In addition, if your work relies on software libraries, or was inspired by looking at other work, it is appropriate to acknowledge this intellectual debt too.)

Owner

Name: Caltech Library
Login: caltechlibrary
Kind: organization
Email: helpdesk@library.caltech.edu
Location: Pasadena, CA 91125

Website: https://www.library.caltech.edu/
Repositories: 84
Profile: https://github.com/caltechlibrary

We manage the physical and digital holdings of the California Institute of Technology, provide services and training, and develop open-source software.

CodeMeta (codemeta.json)

{
  "@context": "https://doi.org/10.5063/schema/codemeta-2.0",
  "@type": "SoftwareSourceCode",
  "description": "feeds-lunr is an experiment for a search based in Python Lunr and LunrJS for contents of feeds.library.caltech.edu",
  "name": "feeds-lunr",
  "codeRepository": "https://github.com/caltechlibrary/feeds-lunr",
  "issueTracker": "https://github.com/caltechlibrary/feeds-lunr/issues",
  "license": "https://github.com/caltechlibrary/feeds-lunr/blob/master/LICENSE",
  "version": "0.0.1",
  "author": [
    {
      "@type": "Person",
      "givenName": "R. S.",
      "familyName": "Doiel",
      "affiliation": "California Institute of Technology Library",
      "email": "rsdoiel@library.caltech.edu",
      "@id": "https://orcid.org/0000-0003-0900-6903"
    }
  ],
  "developmentStatus": "concept",
  "downloadUrl": "https://github.com/caltechlibrary/feeds-lunr/archive/0.0.1.zip",
  "keywords": [
    "software",
    "search"
  ],
  "maintainer": "https://orcid.org/0000-0003-0900-6903"
}

GitHub Events

Total

Last Year

Issues and Pull Requests

Last synced: about 1 year ago

All Time

Total issues: 0
Total pull requests: 0
Average time to close issues: N/A
Average time to close pull requests: N/A
Total issue authors: 0
Total pull request authors: 0
Average comments per issue: 0
Average comments per pull request: 0
Merged pull requests: 0
Bot issues: 0
Bot pull requests: 0

Past Year

Issues: 0
Pull requests: 0
Average time to close issues: N/A
Average time to close pull requests: N/A
Issue authors: 0
Pull request authors: 0
Average comments per issue: 0
Average comments per pull request: 0
Merged pull requests: 0
Bot issues: 0
Bot pull requests: 0

ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Open Source Science