Welcome to Capitains’ Nautilus’ documentation!

Capitains Nautilus

https://coveralls.io/repos/github/Capitains/Nautilus/badge.svg?branch=master https://travis-ci.org/Capitains/Nautilus.svg?branch=master https://api.codacy.com/project/badge/grade/c76dc6ce6b324246927a49adf7e7fa46 https://badge.fury.io/py/capitains_nautilus.svg Documentation https://zenodo.org/badge/45260156.svg

Documentation

CapiTainS Nautilus provides a Flask extension to build upon MyCapytain resolver. The finale goal of the application, built upon MyCapytain, is to serve either as a Web-API provider (Currently supporting CTS, partly DTS. OAI-PMH and a Sparql endpoint are scheduled.) These API can be used to access portion of or complete texts using standards. Metadata are exposed as well.

A second goal of Nautilus is to serve as a cache wrapper for resolver, in order to speed up serving texts for user interfaces such as Nemo .

A known implementation can be found at the University of Leipzig . You can find the set-up files on Github

Trying Nautilus with a test dataset example

With Python 3 only !

git clone https://github.com/Capitains/Nautilus.git
virtualenv -p /usr/bin/python3 venv
source venv/bin/activate
python app.py

Now go to http://localhost:5000 and check out http://localhost:5000/api/cts , http://localhost:5000/api/dts/collections, http://localhost:5000/api/cts?request=GetValidReff

Running Nautilus from the command line

This small tutorial takes that you have one or more Capitains formated repositories (such as http://github.com/PerseusDL/canonical-latinLit ) in the folders /home/USERNAME/repository1 where USERNAME is your user session name.

  1. (Advised) Create a virtual environment and source it : virtualenv -p /usr/bin/python3 env, source env/bin/activate
  2. With development version:
    • Clone the repository : git clone https://github.com/Capitains/Nautilus.git
    • Go to the directory : cd Nautilus
    • Install the source with develop option : python setup.py develop
  1. With production version (not available for now):
    • Install from pip : pip install capitains-nautilus
  2. You will be able now to call capitains nautilus help information through capitains-nautilus --help
  3. Basic setting for testing a directory is capitains-nautilus --debug /home/USERNAME/repository1. This can take more than one repository at the end such as capitains-nautilus --debug /home/USERNAME/repository1 /home/USERNAME/repository2. You can force host and port through –host and –port parameters.

Source for the tests

Textual resources and inventories are owned by Perseus under CC-BY Licences. See https://github.com/PerseusDL/canonical-latinLit and https://github.com/PerseusDL/canonical-farsiLit