https://github.com/varda/manwe

A Python client library and command line interface to the Varda database for genomic variation frequencies
https://github.com/varda/manwe

Last synced: 5 months ago
JSON representation

A Python client library and command line interface to the Varda database for genomic variation frequencies

• Host: GitHub
• URL: https://github.com/varda/manwe
• Owner: varda
• License: other
• Archived: true
• Created: 2013-04-02T13:35:00.000Z (about 13 years ago)
• Default Branch: master
• Last Pushed: 2015-12-22T20:45:23.000Z (over 10 years ago)
• Last Synced: 2025-08-31T07:36:52.622Z (10 months ago)
• Language: Python
• Homepage: https://manwe.readthedocs.org
• Size: 233 KB
• Stars: 3
• Watchers: 8
• Forks: 2
• Open Issues: 2
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGES
  • License: LICENSE

Awesome Lists containing this project

README

          
Manwë

=====

**Warning:** This is a work in progress, probably not yet ready for use!

Manwë is a Python client library for working with the `Varda`_ database for

genomic variation frequencies. It also provides a command line interface to

some of its functionality.

The main goal of Manwë is to offer the complete Varda API, but on an

abstraction level that is nice to work with from Python code.

.. code-block:: pycon

    >>> import manwe

    >>> session = manwe.Session()

    >>> user = session.create_user('testlogin', 'password')

    >>> user.dirty

    False

    >>> user.name = 'Test User'

    >>> user.dirty

    True

    >>> user.save()

    >>> user.dirty

    False

    >>> for sample in session.samples():

    ...     print sample.user.name

    ...

    Rob Userman

    Barry Robsfriend

    Rob Userman

To install the latest release via PyPI using pip::

    pip install manwe

Documentation

-------------

The `latest documentation `_ with user guide

and API reference is hosted at Read The Docs.

You can also compile the documentation directly from the source code by

running ``make html`` from the ``doc/`` subdirectory. This requires `Sphinx`_

to be installed.

Copyright

---------

Manwë is licensed under the MIT License, see the LICENSE file for details. See

the AUTHORS file for a list of authors.

.. _Sphinx: http://sphinx-doc.org/

.. _Varda: https://github.com/varda/varda