Commit 7a4a4c19 authored by Mark Hymers's avatar Mark Hymers
Browse files

New upstream version 0.7.3

parents
Copyright 2016-2018 University of Oxford, Oxford, UK
The fsleyes-widgets library
Copyright 2016-2018 University of Oxford, Oxford, UK.
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.
include LICENSE
include COPYRIGHT
include requirements.txt
include requirements-dev.txt
include pytest.ini
recursive-include doc *
recursive-exclude doc/html *
recursive-include tests *
Metadata-Version: 1.1
Name: fsleyes-widgets
Version: 0.7.3
Summary: A collection of wxPython widgets used by FSLeyes
Home-page: https://git.fmrib.ox.ac.uk/fsl/fsleyes/widgets
Author: Paul McCarthy
Author-email: pauldmccarthy@gmail.com
License: Apache License Version 2.0
Description: fsleyes-widgets
===============
.. image:: https://img.shields.io/pypi/v/fsleyes-widgets.svg
:target: https://pypi.python.org/pypi/fsleyes-widgets/
.. image:: https://anaconda.org/conda-forge/fsleyes-widgets/badges/version.svg
:target: https://anaconda.org/conda-forge/fsleyes-widgets
.. image:: https://git.fmrib.ox.ac.uk/fsl/fsleyes/widgets/badges/master/coverage.svg
:target: https://git.fmrib.ox.ac.uk/fsl/fsleyes/widgets/commits/master/
The ``fsleyes-widgets`` package contains a collection of GUI widgets and
utilities, based on `wxPython <http://www.wxpython.org>`_. These widgets are
used by `fsleyes-props <https://git.fmrib.ox.ac.uk/fsl/fsleyes/props>`_ and
`FSLeyes <https://git.fmrib.ox.ac.uk/fsl/fsleyes/fsleyes>`_,
Installation
------------
You can install ``fsleyes-widgets`` via pip. If you are using Linux, you need
to install wxPython first, as binaries are not available on PyPI. Change the
URL for your specific platform::
pip install -f https://extras.wxpython.org/wxPython4/extras/linux/gtk2/ubuntu-16.04/ wxpython
Then install ``fsleyes-widgets`` like so::
pip install fsleyes-widgets
``fsleyes-widgets`` is also available on
`conda-forge <https://conda-forge.org/>`_::
conda install -c conda-forge fsleyes-widgets
Dependencies
------------
All of the dependencies of ``fsleyes-widgets`` are listed in the
`requirements.txt <requirements.txt>`_ file.
Requirements for running tests and building the documentation are listed in the
`requirements-dev.txt <requirements-dev.txt>`_ file.
Documentation
-------------
``fsleyes-widgets`` is documented using
`sphinx <http://http://sphinx-doc.org/>`_. You can build the API documentation
by running::
pip install -r requirements-dev.txt
python setup.py doc
The HTML documentation will be generated and saved in the ``doc/html/``
directory.
Tests
-----
Run the test suite via::
pip install -r requirements-dev.txt
python setup.py test
Many of the tests assume that a display is accessible - if you are running on
a headless machine, you may need to run the tests using ``xvfb-run``.
Contributing
------------
If you would like to contribute to ``fsleyes-widgets``, take a look at the
``fslpy`` `contributing guide
<https://git.fmrib.ox.ac.uk/fsl/fslpy/blob/master/doc/contributing.rst>`_.
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Topic :: Software Development :: Libraries :: Python Modules
fsleyes-widgets
===============
.. image:: https://img.shields.io/pypi/v/fsleyes-widgets.svg
:target: https://pypi.python.org/pypi/fsleyes-widgets/
.. image:: https://anaconda.org/conda-forge/fsleyes-widgets/badges/version.svg
:target: https://anaconda.org/conda-forge/fsleyes-widgets
.. image:: https://git.fmrib.ox.ac.uk/fsl/fsleyes/widgets/badges/master/coverage.svg
:target: https://git.fmrib.ox.ac.uk/fsl/fsleyes/widgets/commits/master/
The ``fsleyes-widgets`` package contains a collection of GUI widgets and
utilities, based on `wxPython <http://www.wxpython.org>`_. These widgets are
used by `fsleyes-props <https://git.fmrib.ox.ac.uk/fsl/fsleyes/props>`_ and
`FSLeyes <https://git.fmrib.ox.ac.uk/fsl/fsleyes/fsleyes>`_,
Installation
------------
You can install ``fsleyes-widgets`` via pip. If you are using Linux, you need
to install wxPython first, as binaries are not available on PyPI. Change the
URL for your specific platform::
pip install -f https://extras.wxpython.org/wxPython4/extras/linux/gtk2/ubuntu-16.04/ wxpython
Then install ``fsleyes-widgets`` like so::
pip install fsleyes-widgets
``fsleyes-widgets`` is also available on
`conda-forge <https://conda-forge.org/>`_::
conda install -c conda-forge fsleyes-widgets
Dependencies
------------
All of the dependencies of ``fsleyes-widgets`` are listed in the
`requirements.txt <requirements.txt>`_ file.
Requirements for running tests and building the documentation are listed in the
`requirements-dev.txt <requirements-dev.txt>`_ file.
Documentation
-------------
``fsleyes-widgets`` is documented using
`sphinx <http://http://sphinx-doc.org/>`_. You can build the API documentation
by running::
pip install -r requirements-dev.txt
python setup.py doc
The HTML documentation will be generated and saved in the ``doc/html/``
directory.
Tests
-----
Run the test suite via::
pip install -r requirements-dev.txt
python setup.py test
Many of the tests assume that a display is accessible - if you are running on
a headless machine, you may need to run the tests using ``xvfb-run``.
Contributing
------------
If you would like to contribute to ``fsleyes-widgets``, take a look at the
``fslpy`` `contributing guide
<https://git.fmrib.ox.ac.uk/fsl/fslpy/blob/master/doc/contributing.rst>`_.
``fsleyes-widgets`` release history
===================================
.. include:: ../CHANGELOG.rst
# -*- coding: utf-8 -*-
#
# fsleyes-widgets documentation build configuration file, created by
# sphinx-quickstart on Fri Jun 27 13:33:53 2014.
#
# This file is execfile()d with the current directory set to its
# containing dir.
#
# Note that not all possible configuration values are present in this
# autogenerated file.
#
# All configuration values have a default; values that are commented out
# serve to show the default.
import sys
import os
import datetime
date = datetime.date.today()
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
#sys.path.insert(0, os.path.abspath('.'))
# -- General configuration ------------------------------------------------
# If your documentation needs a minimal Sphinx version, state it here.
#needs_sphinx = '1.0'
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
'sphinx.ext.autodoc',
'sphinx.ext.autosummary',
'sphinx.ext.mathjax',
# 'sphinxcontrib.restbuilder',
]
# Configure restructured text output
rst_file_suffix = '.rst'
rst_link_suffix = ''
rest_line_width = 78
rst_indent = 4
def rst_file_transform(docname):
if docname == 'index':
docname = 'home'
return docname.title() + rst_file_suffix
def rst_link_transform(docname):
if docname == 'index':
docname = 'home'
return 'wiki/' + docname.title()
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
# The suffix of source filenames.
source_suffix = '.rst'
# The encoding of source files.
#source_encoding = 'utf-8-sig'
# The master toctree document.
master_doc = 'index'
# General information about the project.
project = u'fsleyes-widgets'
copyright = u'{}, Paul McCarthy, University of Oxford, Oxford, UK'.format(
date.year)
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
#
# The short X.Y version.
import fsleyes_widgets
version = fsleyes_widgets.__version__
# The full version, including alpha/beta/rc tags.
release = version
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#language = None
# There are two options for replacing |today|: either, you set today to some
# non-false value, then it is used:
#today = ''
# Else, today_fmt is used as the format for a strftime call.
#today_fmt = '%B %d, %Y'
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
exclude_patterns = ['_build']
# The reST default role (used for this markup: `text`) to use for all
# documents.
#default_role = None
# If true, '()' will be appended to :func: etc. cross-reference text.
#add_function_parentheses = True
# If true, the current module name will be prepended to all description
# unit titles (such as .. function::).
#add_module_names = True
# If true, sectionauthor and moduleauthor directives will be shown in the
# output. They are ignored by default.
#show_authors = False
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'
# A list of ignored prefixes for module index sorting.
#modindex_common_prefix = []
# If true, keep warnings as "system message" paragraphs in the built documents.
#keep_warnings = False
# -- Options for HTML output ----------------------------------------------
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
html_theme = 'sphinx_rtd_theme'
# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
# documentation.
#html_theme_options = {}
# Add any paths that contain custom themes here, relative to this directory.
#html_theme_path = []
# The name for this set of Sphinx documents. If None, it defaults to
# "<project> v<release> documentation".
#html_title = None
# A shorter title for the navigation bar. Default is the same as html_title.
#html_short_title = None
# The name of an image file (relative to this directory) to place at the top
# of the sidebar.
#html_logo = None
# The name of an image file (within the static path) to use as favicon of the
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
# pixels large.
#html_favicon = None
# Add any paths that contain custom static files (such as style sheets) relative,
# here to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = []
# Add any extra paths that contain custom files (such as robots.txt or
# .htaccess) here, relative to this directory. These files are copied
# directly to the root of the documentation.
#html_extra_path = []
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format.
#html_last_updated_fmt = '%b %d, %Y'
# If true, SmartyPants will be used to convert quotes and dashes to
# typographically correct entities.
#html_use_smartypants = True
# Custom sidebar templates, maps document names to template names.
#html_sidebars = {}
# Additional templates that should be rendered to pages, maps page names to
# template names.
#html_additional_pages = {}
# If false, no module index is generated.
#html_domain_indices = True
# If false, no index is generated.
#html_use_index = True
# If true, the index is split into individual pages for each letter.
#html_split_index = False
# If true, links to the reST sources are added to the pages.
#html_show_sourcelink = True
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
#html_show_sphinx = True
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
#html_show_copyright = True
# If true, an OpenSearch description file will be output, and all pages will
# contain a <link> tag referring to it. The value of this option must be the
# base URL from which the finished HTML is served.
#html_use_opensearch = ''
# This is the file name suffix for HTML files (e.g. ".xhtml").
#html_file_suffix = None
# Output file base name for HTML help builder.
htmlhelp_basename = 'doc'
# -- Options for LaTeX output ---------------------------------------------
latex_elements = {
# The paper size ('letterpaper' or 'a4paper').
#'papersize': 'letterpaper',
# The font size ('10pt', '11pt' or '12pt').
#'pointsize': '10pt',
# Additional stuff for the LaTeX preamble.
#'preamble': '',
}
# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title,
# author, documentclass [howto, manual, or own class]).
latex_documents = [
('index', 'fsleyes-widgets.tex', u'fsleyes-widgets Documentation',
u'Author', 'manual'),
]
# The name of an image file (relative to this directory) to place at the top of
# the title page.
#latex_logo = None
# For "manual" documents, if this is true, then toplevel headings are parts,
# not chapters.
#latex_use_parts = False
# If true, show page references after internal links.
#latex_show_pagerefs = False
# If true, show URL addresses after external links.
#latex_show_urls = False
# Documents to append as an appendix to all manuals.
#latex_appendices = []
# If false, no module index is generated.
#latex_domain_indices = True
# -- Options for manual page output ---------------------------------------
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
('index', 'fsleyes-widgets', u'fsleyes-widgets Documentation',
[u'Author'], 1)
]
# If true, show URL addresses after external links.
#man_show_urls = False
# -- Options for Texinfo output -------------------------------------------
# Grouping the document tree into Texinfo files. List of tuples
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
('index', 'fsleyes-widgets', u'fsleyes-widgets Documentation',
u'Author', 'fsleyes-widgets', 'One line description of project.',
'Miscellaneous'),
]
# Documents to append as an appendix to all manuals.
#texinfo_appendices = []
# If false, no module index is generated.
#texinfo_domain_indices = True
# How to display URL addresses: 'footnote', 'no', or 'inline'.
#texinfo_show_urls = 'footnote'
# If true, do not generate a @detailmenu in the "Top" node's menu.
#texinfo_no_detailmenu = False
# -- Options for Epub output ----------------------------------------------
# Bibliographic Dublin Core info.
epub_title = u'fsleyes-widgets'
epub_author = u'Author'
epub_publisher = u'Author'
epub_copyright = u'2014, Author'
# The basename for the epub file. It defaults to the project name.
#epub_basename = u'fsleyes-widgets'
# The HTML theme for the epub output. Since the default themes are not optimized
# for small screen space, using the same theme for HTML and epub output is
# usually not wise. This defaults to 'epub', a theme designed to save visual
# space.
#epub_theme = 'epub'
# The language of the text. It defaults to the language option
# or en if the language is not set.
#epub_language = ''
# The scheme of the identifier. Typical schemes are ISBN or URL.
#epub_scheme = ''
# The unique identifier of the text. This can be a ISBN number
# or the project homepage.
#epub_identifier = ''
# A unique identification for the text.
#epub_uid = ''
# A tuple containing the cover image and cover page html template filenames.
#epub_cover = ()
# A sequence of (type, uri, title) tuples for the guide element of content.opf.
#epub_guide = ()
# HTML files that should be inserted before the pages created by sphinx.
# The format is a list of tuples containing the path and title.
#epub_pre_files = []
# HTML files shat should be inserted after the pages created by sphinx.
# The format is a list of tuples containing the path and title.
#epub_post_files = []
# A list of files that should not be packed into the epub file.
epub_exclude_files = ['search.html']
# The depth of the table of contents in toc.ncx.
#epub_tocdepth = 3
# Allow duplicate toc entries.
#epub_tocdup = True
# Choose between 'default' and 'includehidden'.
#epub_tocscope = 'default'
# Fix unsupported image types using the PIL.
#epub_fix_images = False
# Scale large images.
#epub_max_image_width = 0
# How to display URL addresses: 'footnote', 'no', or 'inline'.
#epub_show_urls = 'inline'
# If false, no index is generated.
#epub_use_index = True
# ensure that class __init__ docstring is included.
autoclass_content = 'both'
# Document private members
autodoc_default_flags = ['private-members', 'special-members']
# Documentation for python modules is in the same order
# as the source code.
autodoc_member_order = 'bysource'
``fsleyes_widgets.autotextctrl``
================================
.. automodule:: fsleyes_widgets.autotextctrl
:members:
:undoc-members:
:show-inheritance:
``fsleyes_widgets.bitmapradio``
===============================
.. automodule:: fsleyes_widgets.bitmapradio
:members:
:undoc-members:
:show-inheritance:
``fsleyes_widgets.bitmaptoggle``
================================
.. automodule:: fsleyes_widgets.bitmaptoggle
:members:
:undoc-members:
:show-inheritance:
``fsleyes_widgets.colourbutton``
================================
.. automodule:: fsleyes_widgets.colourbutton
:members:
:undoc-members:
:show-inheritance:
``fsleyes_widgets.dialog``
==========================
.. automodule:: fsleyes_widgets.dialog
:members:
:undoc-members:
:show-inheritance:
``fsleyes_widgets.elistbox``
============================
.. automodule:: fsleyes_widgets.elistbox
:members:
:undoc-members:
:show-inheritance:
``fsleyes_widgets.floatslider``
===============================
.. automodule:: fsleyes_widgets.floatslider
:members:
:undoc-members:
:show-inheritance: