Start roughing out the basics.
This commit is contained in:
Peter Williams
Родитель
983731b028
Коммит
1b1beec5e9
|
|
@ -0,0 +1 @@
|
|||
/_build/
|
||||
|
|
@ -0,0 +1,6 @@
|
|||
APIResponseError
|
||||
================
|
||||
|
||||
.. currentmodule:: wwt_api_client
|
||||
|
||||
.. autoexception:: APIResponseError
|
||||
|
|
@ -0,0 +1,27 @@
|
|||
Client
|
||||
======
|
||||
|
||||
.. currentmodule:: wwt_api_client
|
||||
|
||||
.. autoclass:: Client
|
||||
:show-inheritance:
|
||||
|
||||
.. rubric:: Attributes Summary
|
||||
|
||||
.. autosummary::
|
||||
|
||||
~Client.session
|
||||
|
||||
.. rubric:: Methods Summary
|
||||
|
||||
.. autosummary::
|
||||
|
||||
~Client.show_image
|
||||
|
||||
.. rubric:: Attributes Documentation
|
||||
|
||||
.. autoattribute:: session
|
||||
|
||||
.. rubric:: Methods Documentation
|
||||
|
||||
.. automethod:: show_image
|
||||
186
docs/conf.py
186
docs/conf.py
|
|
@ -1,191 +1,27 @@
|
|||
#!/usr/bin/env python3
|
||||
# -*- coding: utf-8 -*-
|
||||
#
|
||||
# wwt_api_client documentation build configuration file, copied from pywwt.
|
||||
#
|
||||
# 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.
|
||||
# Configuration file for the Sphinx documentation builder.
|
||||
|
||||
# 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.
|
||||
#
|
||||
# import os
|
||||
# import sys
|
||||
# sys.path.insert(0, os.path.abspath('.'))
|
||||
project = 'wwt_api_client'
|
||||
author = 'Peter K. G. Williams'
|
||||
copyright = '2019 ' + author
|
||||
|
||||
release = '0.1.0dev0'
|
||||
|
||||
# -- 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',
|
||||
extensions = [
|
||||
'sphinx.ext.autodoc',
|
||||
'sphinx.ext.doctest',
|
||||
'sphinx.ext.intersphinx',
|
||||
'sphinx.ext.mathjax',
|
||||
'sphinx.ext.viewcode',
|
||||
'sphinx_automodapi.automodapi',
|
||||
'sphinx_automodapi.smart_resolver',
|
||||
'numpydoc']
|
||||
'numpydoc',
|
||||
]
|
||||
|
||||
# Add any paths that contain templates here, relative to this directory.
|
||||
templates_path = ['_templates']
|
||||
|
||||
# The suffix(es) of source filenames.
|
||||
# You can specify multiple suffix as a list of string:
|
||||
#
|
||||
# source_suffix = ['.rst', '.md']
|
||||
source_suffix = '.rst'
|
||||
|
||||
# The master toctree document.
|
||||
master_doc = 'index'
|
||||
|
||||
# General information about the project.
|
||||
project = 'wwt_api_client'
|
||||
author = 'Peter K. G. Williams'
|
||||
copyright = '2019 ' + author
|
||||
|
||||
# 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.
|
||||
version = '0.1.0dev0'
|
||||
# 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.
|
||||
#
|
||||
# This is also used if you do content translation via gettext catalogs.
|
||||
# Usually you set "language" from the command line for these cases.
|
||||
language = None
|
||||
|
||||
# List of patterns, relative to source directory, that match files and
|
||||
# directories to ignore when looking for source files.
|
||||
# This patterns also effect to html_static_path and html_extra_path
|
||||
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
|
||||
|
||||
# The name of the Pygments (syntax highlighting) style to use.
|
||||
pygments_style = 'sphinx'
|
||||
numpydoc_class_members_toctree = False
|
||||
|
||||
# If true, `todo` and `todoList` produce output, else they produce nothing.
|
||||
todo_include_todos = 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 static files (such as style sheets) here,
|
||||
# relative to this directory. They are copied after the builtin static files,
|
||||
# so a file named "default.css" will overwrite the builtin "default.css".
|
||||
html_theme = 'alabaster'
|
||||
html_static_path = ['_static']
|
||||
|
||||
# Custom sidebar templates, must be a dictionary that maps document names
|
||||
# to template names.
|
||||
#
|
||||
# This is required for the alabaster theme
|
||||
# refs: http://alabaster.readthedocs.io/en/latest/installation.html#sidebars
|
||||
html_sidebars = {
|
||||
'**': [
|
||||
'about.html',
|
||||
'navigation.html',
|
||||
'relations.html', # needs 'show_related': True theme option to display
|
||||
'searchbox.html',
|
||||
'donate.html',
|
||||
]
|
||||
}
|
||||
|
||||
|
||||
# -- Options for HTMLHelp output ------------------------------------------
|
||||
|
||||
# Output file base name for HTML help builder.
|
||||
htmlhelp_basename = 'wwt_api_clientdoc'
|
||||
|
||||
|
||||
# -- 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': '',
|
||||
|
||||
# Latex figure (float) alignment
|
||||
#
|
||||
# 'figure_align': 'htbp',
|
||||
}
|
||||
|
||||
# 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 = [
|
||||
(master_doc, 'wwt_api_client.tex', 'wwt_api_client Documentation',
|
||||
'Thomas P. Robitaille', 'manual'),
|
||||
]
|
||||
|
||||
|
||||
# -- Options for manual page output ---------------------------------------
|
||||
|
||||
# One entry per manual page. List of tuples
|
||||
# (source start file, name, description, authors, manual section).
|
||||
man_pages = [
|
||||
(master_doc, 'wwt_api_client', 'wwt_api_client Documentation',
|
||||
[author], 1)
|
||||
]
|
||||
|
||||
|
||||
# -- 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 = [
|
||||
(master_doc, 'wwt_api_client', 'wwt_api_client Documentation',
|
||||
author, 'wwt_api_client', 'One line description of project.',
|
||||
'Miscellaneous'),
|
||||
]
|
||||
|
||||
|
||||
|
||||
# Configuration for intersphinx: refer to the Python standard library.
|
||||
intersphinx_mapping = {
|
||||
'python': ('https://docs.python.org/3/',
|
||||
(None, 'http://data.astropy.org/intersphinx/python3.inv')),
|
||||
}
|
||||
numpydoc_show_class_members = False
|
||||
|
||||
nitpicky = True
|
||||
nitpick_ignore = [('py:class', 'ipywidgets.widgets.domwidget.DOMWidget')]
|
||||
|
||||
default_role = 'obj'
|
||||
|
||||
html_logo = 'images/logo.png'
|
||||
|
|
|
|||
|
|
@ -7,12 +7,12 @@ Try without installing
|
|||
Not yet implemented.
|
||||
|
||||
Installing wwt_api_client with conda (recommended)
|
||||
-----------------------------------------
|
||||
--------------------------------------------------
|
||||
|
||||
Not yet implemented.
|
||||
|
||||
Installing wwt_api_client with pip
|
||||
-------------------------
|
||||
----------------------------------
|
||||
|
||||
You can also install the latest release of wwt_api_client using `pip
|
||||
<https://pip.pypa.io/en/stable/>`_::
|
||||
|
|
|
|||
|
|
@ -0,0 +1,35 @@
|
|||
@ECHO OFF
|
||||
|
||||
pushd %~dp0
|
||||
|
||||
REM Command file for Sphinx documentation
|
||||
|
||||
if "%SPHINXBUILD%" == "" (
|
||||
set SPHINXBUILD=sphinx-build
|
||||
)
|
||||
set SOURCEDIR=.
|
||||
set BUILDDIR=_build
|
||||
|
||||
if "%1" == "" goto help
|
||||
|
||||
%SPHINXBUILD% >NUL 2>NUL
|
||||
if errorlevel 9009 (
|
||||
echo.
|
||||
echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
|
||||
echo.installed, then set the SPHINXBUILD environment variable to point
|
||||
echo.to the full path of the 'sphinx-build' executable. Alternatively you
|
||||
echo.may add the Sphinx directory to PATH.
|
||||
echo.
|
||||
echo.If you don't have Sphinx installed, grab it from
|
||||
echo.http://sphinx-doc.org/
|
||||
exit /b 1
|
||||
)
|
||||
|
||||
%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
|
||||
goto end
|
||||
|
||||
:help
|
||||
%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
|
||||
|
||||
:end
|
||||
popd
|
||||
4
setup.py
4
setup.py
|
|
@ -44,10 +44,12 @@ setup_args = dict(
|
|||
],
|
||||
include_package_data = True,
|
||||
install_requires = [
|
||||
'six'
|
||||
'requests',
|
||||
'six',
|
||||
],
|
||||
extras_require = {
|
||||
'test': [
|
||||
'httpretty',
|
||||
'pytest',
|
||||
'pytest-cov',
|
||||
],
|
||||
|
|
|
|||
|
|
@ -2,4 +2,66 @@
|
|||
# Copyright 2019 the .Net Foundation
|
||||
# Distributed under the terms of the revised (3-clause) BSD license.
|
||||
|
||||
from __future__ import absolute_import, division, print_function
|
||||
|
||||
import requests
|
||||
|
||||
from ._version import version_info, __version__ # noqa
|
||||
|
||||
__all__ = '''
|
||||
APIResponseError
|
||||
Client
|
||||
DEFAULT_API_BASE
|
||||
'''.split()
|
||||
|
||||
DEFAULT_API_BASE = 'http://www.worldwidetelescope.org'
|
||||
|
||||
|
||||
class APIResponseError(Exception):
|
||||
"""Raised when the API returns an HTTP error.
|
||||
|
||||
"""
|
||||
def __init__(self, value):
|
||||
self.value = value
|
||||
|
||||
def __str__(self):
|
||||
return str(self.value)
|
||||
|
||||
|
||||
class Client(object):
|
||||
_api_base = None
|
||||
_session = None
|
||||
|
||||
def __init__(self, api_base=None):
|
||||
if api_base is None:
|
||||
api_base = DEFAULT_API_BASE
|
||||
|
||||
self._api_base = api_base
|
||||
|
||||
|
||||
@property
|
||||
def session(self):
|
||||
if self._session is None:
|
||||
self._session = requests.session()
|
||||
|
||||
return self._session
|
||||
|
||||
def show_image(self):
|
||||
"""Do some stuff.
|
||||
|
||||
Parameters
|
||||
----------
|
||||
yo : type
|
||||
Def
|
||||
|
||||
Returns
|
||||
-------
|
||||
text : type
|
||||
|
||||
"""
|
||||
endpoint = self._api_base + '/WWTWeb/ShowImage.aspx'
|
||||
resp = self._session.get(endpoint)
|
||||
if not resp.ok:
|
||||
raise APIResponseError(resp.text)
|
||||
|
||||
return resp.text
|
||||
|
|
|
|||
|
|
@ -6,4 +6,4 @@ version_info = (0, 1, 0, 'dev', 0)
|
|||
|
||||
_specifier_ = {'alpha': 'a', 'beta': 'b', 'candidate': 'rc', 'final': '', 'dev': 'dev'}
|
||||
_ext = '' if version_info[3] == 'final' else _specifier_[version_info[3]] + str(version_info[4])
|
||||
__version__ = '%s.%s.%s%s' % (version_info[0], version_info[1], version_info[2], ext)
|
||||
__version__ = '%s.%s.%s%s' % (version_info[0], version_info[1], version_info[2], _ext)
|
||||
|
|
|
|||
Загрузка…
Ссылка в новой задаче