Skip to main content

A python library to read from and write to the Trompa CE

Project description

Trompa Contributor Environment Python Client

Music Technology Group, Universitat Pompeu Fabra, Barcelona

A python library to read from and write to the Trompa Contributor Environment (Trompa CE).

Installation

To install, run

python setup.py install

to install the package and dependencies

Using the library

This library connects to an existing Trompa CE instance. For testing on a local environment the docker containers from https://github.com/trompamusic/ce-api can be run.

Basic example code for using the library to add an artist to the Trompa CE.

To use the library an existing Trompa Contributor environment

import asyncio
import os
import trompace as ce

from trompace import config
from trompace.connection import submit_query
from trompace.mutations.person import mutation_create_artist

async def main():

    qry = mutation_create_artist(
        artist_name="A. J. Fynn",
        publisher="https://www.cpdl.org",
        contributor="https://www.cpdl.org",
        creator="https://www.upf.edu",
        source="https://www.cpdl.org/wiki/index.php/A._J._Fynn",
        language="en",
        formatin="text/html",
        date=datetime.now(),
        birthDate=1860,
        deathDate=1920,
    )

    response = await ce.connection.submit_query(qry)

    print(response)


if __name__ == "__main__":
    config_file = os.path.join(os.path.abspath(os.path.dirname(__file__)), 'import.ini')

    if path.exists(config_file):
        ce.config.read_config(config_file)
    else:
        ce.config.set_server('http://localhost:4000', False)

    asyncio.run(main())

License

Copyright 2019 Music Technology Group, Universitat Pompeu Fabra

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

trompace_client-0.1-py3-none-any.whl (39.2 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page