Module tf.app

Make use of a corpus.

The advanced-API provides extra functionality of top of the core of TF. The most notable things are downloading corpus data and methods for (pretty) display corpus material.

The real power of the advanced API is unleashed when there are well-tuned configuration settings for a corpus, and possibly some supporting application code and CSS styling.

This power can be invoked by a very simple command: use("org/repo").

For a detailed description, see tf.about.usefunc.

"""
Make use of a corpus.

The advanced-API provides extra functionality of top of the core of TF.
The most notable things are downloading corpus data and methods for (pretty)
display corpus material.

The real power of the advanced API is unleashed when there are well-tuned configuration
settings for a corpus, and possibly some supporting application code and CSS styling.

This power can be invoked by a very simple command: `use("org/repo")`.

For a detailed description, see `tf.about.usefunc`.
"""

from .advanced.app import findApp, useApp


# START AN APP


def use(appName, *args, backend=None, **kwargs):
    """Make use of a corpus.

    For a detailed description, see `tf.about.usefunc`.

    Parameters
    ----------
    appName: string

    backend: string, optional None
        If present, it is `github` or `gitlab`
        or a GitLab instance such as `gitlab.huc.knaw.nl`.
        If absent, `None` or empty, it is `github`.

    args:
        Do not pass any other positional argument!

    kwargs:
        Used to initialize the corpus app that we use.
        That is either an uncustomized `tf.advanced.app.App` or
        a customization of it.

    Returns
    -------
    A: object
        The object whose attributes and methods constitute the advanced API.

    See Also
    --------
    tf.advanced.app.App
    """

    (appName, checkoutApp, dataLoc, backend) = useApp(appName, backend)

    return findApp(appName, checkoutApp, dataLoc, backend, False, *args, **kwargs)

Functions

def use(appName, *args, backend=None, **kwargs)

Make use of a corpus.

For a detailed description, see tf.about.usefunc.

Parameters

appName : string

 

backend : string, optional None

If present, it is github or gitlab or a GitLab instance such as gitlab.huc.knaw.nl. If absent, None or empty, it is github.

args: Do not pass any other positional argument!

kwargs: Used to initialize the corpus app that we use. That is either an uncustomized App or a customization of it.

Returns

A : object

The object whose attributes and methods constitute the advanced API.

See Also

App

Expand source code Browse git

def use(appName, *args, backend=None, **kwargs):
    """Make use of a corpus.

    For a detailed description, see `tf.about.usefunc`.

    Parameters
    ----------
    appName: string

    backend: string, optional None
        If present, it is `github` or `gitlab`
        or a GitLab instance such as `gitlab.huc.knaw.nl`.
        If absent, `None` or empty, it is `github`.

    args:
        Do not pass any other positional argument!

    kwargs:
        Used to initialize the corpus app that we use.
        That is either an uncustomized `tf.advanced.app.App` or
        a customization of it.

    Returns
    -------
    A: object
        The object whose attributes and methods constitute the advanced API.

    See Also
    --------
    tf.advanced.app.App
    """

    (appName, checkoutApp, dataLoc, backend) = useApp(appName, backend)

    return findApp(appName, checkoutApp, dataLoc, backend, False, *args, **kwargs)