Metadata-Version: 2.1
Name: bartocsuggest
Version: 0.0.2
Summary: Vocabulary suggestion module based on BARTOC FAST
Home-page: https://github.com/MHindermann/bartocsuggest
Author: Maximilian Hindermann
Author-email: maximilian.hindermann@unibas.ch
License: UNKNOWN
Description: # bartocsuggest
        
        A Python module that suggests vocabularies given a list of words based on the BARTOC FAST API (https://bartoc-fast.ub.unibas.ch/bartocfast/api).
        
        ## Installation
        
        ```
        pip install bartocsuggest
        ```
        
        ## Example
        ```
        from bartocsuggest import Session
        
        mywords = ["auction", "market", "marketing", "market economy", "perfect competition", "capitalism", "stock market"]
        
        session = Session(mywords)
        session.suggest(verbose=True)
        ```
        
        The output to the console should look something like this:
        
        ```
        73 vocabularies given sensitivity 1. From best to worst (vocabularies with no matches are excluded):
        psh.ntkcz.cz, recall: 1.0
        vocabulary.worldbank.org, recall: 1.0
        zbw.eu, recall: 1.0
        eurovoc.europa.eu, recall: 0.8571428571428571
        lod.gesis.org, recall: 0.8571428571428571
        www.yso.fi/onto/yso, recall: 0.7142857142857143
        www.yso.fi/onto/koko, recall: 0.7142857142857143
        www.yso.fi/onto/liito, recall: 0.7142857142857143
        data.bibliotheken.nl, recall: 0.7142857142857143
        lod.nal.usda.gov, recall: 0.7142857142857143
        www.yso.fi/onto/juho, recall: 0.5714285714285714
        crai.ub.edu, recall: 0.5714285714285714
        www.twse.info, recall: 0.5714285714285714
        thesaurus.web.ined.fr, recall: 0.5714285714285714
        aims.fao.org, recall: 0.5714285714285714
        ...
        ```
        
        ## Preloading responses
        The latency for a response from BARTOC FAST is about 5 seconds per word. Preloading responses is hence useful for dealing with long lists of words or for trying out different types of suggestions for a given list of words without having to resend each query.
        
        ```
        from bartocsuggest import Session, Average
        
        # preload words:
        session = Session(300_word_list, "my/preload/folder")
        session.preload(0-99)
        session.preload(100-199)
        session.preload(200-299)
        
        # try out different suggestions:
        suggestion1 = session.suggest(remote=False, verbose=True)
        suggestion2 = session.suggest(remote=False, sensitivity=2, verbose=True)
        suggestion3 = session.suggest(remote=False, score_type="Average", verbose=True)
        ```
        
        ## Documentation
        Documentation available at: https://readthedocs.org/projects/bartocsuggest/
        
        ## License
        bartocsuggest is released under the MIT License.
        
        ## Contact
        Maximilian Hindermann  
        maximilian.hindermann@unibas.ch  
        https://orcid.org/0000-0002-9337-4655
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.7
Description-Content-Type: text/markdown
