From 136b4032dc4f573ba52f37996c11c608e8547a1b Mon Sep 17 00:00:00 2001 From: Peter Bittner Date: Sun, 4 Jun 2017 10:09:16 +0200 Subject: [PATCH 1/3] Delete index.rst --- doc/index.rst | 134 -------------------------------------------------- 1 file changed, 134 deletions(-) delete mode 100644 doc/index.rst diff --git a/doc/index.rst b/doc/index.rst deleted file mode 100644 index d8f5665..0000000 --- a/doc/index.rst +++ /dev/null @@ -1,134 +0,0 @@ -%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% -:mod:`dogapi` --- DataDog's Python API -%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% - -.. module:: dogapi - - -The :mod:`dogapi` module provides :class:`DogHttpApi` - a simple wrapper around -DataDog's HTTP API - and :class:`~dogapi.stats.DogStatsApi` - a tool for collecting metrics -in high performance applications. - - -Installation -============ - -The module can be downloaded from PyPI and installed in one step with -easy_install: - - >>> sudo easy_install dogapi - -Or with pip: - - >>> sudo pip install dogapi - -To install from source, `download `_ a distribution and run: - - >>> sudo python setup.py install - -If you use `virtualenv `_ you do not need to use sudo. - -DogHttpApi -========== -DogHttpApi is a Python client library for DataDog's `HTTP API `_. - - -.. autoclass:: dogapi.http.DogHttpApi - :members: - :inherited-members: - :exclude-members: __init__ - -DogStatsApi -=========== - -.. automodule:: dogapi.stats.dog_stats_api - -.. autoclass:: dogapi.stats.DogStatsApi - - .. method:: start(api_key=api_key, flush_interval=10, flush_in_thread=True, flush_in_greenlet=False, disabled=False) - - Begin flushing metrics with your account's *api_key* every - *flush_interval* seconds. By default, metrics will be flushed in - a seperate thread. :: - - >>> dog_stats_api.start(api_key='my_api_key') - - If you're running a gevent server and want to flush metrics in a - greenlet, set *flush_in_greenlet* to True. Be sure to import and monkey - patch gevent before starting dog_stats_api. :: - - >>> from gevent import monkey; monkey.patch_all() - >>> dog_stats_api.start(api_key='my_api_key', flush_in_greelet=True) - - If you'd like to flush metrics in process, set *flush_in_thread* - to False, though you'll have to call *flush* - manually to post metrics to the server. :: - - >>> dog_stats_api.start(api_key='my_api_key', flush_in_thread=False) - - If for whatever reason, you need to disable metrics collection in a - hurry, set *disabled* to True and metrics won't be collected or flushed. - - >>> dog_stats_api.start(api_key='my_api_key', disabled=True) - - - .. automethod:: gauge - - .. automethod:: increment - - .. automethod:: histogram - - .. automethod:: timed - - .. automethod:: flush - - -.. module:: dogapi -.. data:: dog_stats_api - - A global :class:`~dogapi.stats.DogStatsApi` instance that is easily shared - across an application's modules. Initialize this once in your application's - set-up code and then other modules can import and use it without further - configuration. - - >>> from dogapi import dog_stats_api - >>> dog_stats_api.start(api_key='my_api_key') - - -Here's an example that put's it all together. :: - - # Import the dog stats instance. - from dogapi import dog_stats_api as dog - - # Begin flushing asynchronously with the given api key. After this is done - # once in your application, other modules can import and use dog_stats_api - # without any further configuration. - dog.start(api_key='my_api_key') - - - @dog.timed('home_page.render.time') - def render_home_page(user_id): - """ Render the home page for the given user. """ - - # Fetch the user from the cache or the database - # and record metrics on our cache hits and misses. - user = user_cache.get(user_id) - if user: - dog.increment('user_cache.hit') - else: - dog.increment('user_cache.miss') - user = user_database.get(user_id) - - return render('home.html', user_id) - -Source -====== - -The DogApi source is freely available on Github. Check it out `here -`_. - -Get in Touch -============ - -If you'd like to suggest a feature or report a bug, please add an issue `here `_. If you want to talk about DataDog in general, reach out at `datadoghq.com `_. - From 4476a58c38d49b0eb25e082f72f3de2ba7b5378e Mon Sep 17 00:00:00 2001 From: Peter Bittner Date: Sun, 4 Jun 2017 10:09:52 +0200 Subject: [PATCH 2/3] Delete conf.py --- doc/conf.py | 216 ---------------------------------------------------- 1 file changed, 216 deletions(-) delete mode 100644 doc/conf.py diff --git a/doc/conf.py b/doc/conf.py deleted file mode 100644 index ef82d08..0000000 --- a/doc/conf.py +++ /dev/null @@ -1,216 +0,0 @@ -# -*- coding: utf-8 -*- -# -# Datadog API documentation build configuration file, created by -# sphinx-quickstart on Wed Aug 24 16:17:40 2011. -# -# 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, os - -# 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'] - -# 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'Datadog API' -copyright = u'2012, Datadog, Inc.' - -# 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 = 'v1' -# The full version, including alpha/beta/rc tags. -release = '1.0.0' - -# 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 = [] - - -# -- 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 = 'default' - -# 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 -# " v 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) 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_static_path = ['_static'] - -# 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 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 = 'DatadogAPIdoc' - - -# -- Options for LaTeX output -------------------------------------------------- - -# The paper size ('letter' or 'a4'). -#latex_paper_size = 'letter' - -# The font size ('10pt', '11pt' or '12pt'). -#latex_font_size = '10pt' - -# Grouping the document tree into LaTeX files. List of tuples -# (source start file, target name, title, author, documentclass [howto/manual]). -latex_documents = [ - ('index', 'DatadogAPI.tex', u'Datadog API Documentation', - u'Datadog, Inc.', '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 - -# Additional stuff for the LaTeX preamble. -#latex_preamble = '' - -# 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', 'datadogapi', u'Datadog API Documentation', - [u'Datadog, Inc.'], 1) -] From 6f80ffd0da71006c75abbbc3090b00746336861c Mon Sep 17 00:00:00 2001 From: Peter Bittner Date: Sun, 4 Jun 2017 10:10:05 +0200 Subject: [PATCH 3/3] Delete Makefile --- doc/Makefile | 130 --------------------------------------------------- 1 file changed, 130 deletions(-) delete mode 100644 doc/Makefile diff --git a/doc/Makefile b/doc/Makefile deleted file mode 100644 index f16c02f..0000000 --- a/doc/Makefile +++ /dev/null @@ -1,130 +0,0 @@ -# Makefile for Sphinx documentation -# - -# You can set these variables from the command line. -SPHINXOPTS = -SPHINXBUILD = sphinx-build -PAPER = -BUILDDIR = _build - -# Internal variables. -PAPEROPT_a4 = -D latex_paper_size=a4 -PAPEROPT_letter = -D latex_paper_size=letter -ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . - -.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest - -help: - @echo "Please use \`make ' where is one of" - @echo " html to make standalone HTML files" - @echo " dirhtml to make HTML files named index.html in directories" - @echo " singlehtml to make a single large HTML file" - @echo " pickle to make pickle files" - @echo " json to make JSON files" - @echo " htmlhelp to make HTML files and a HTML help project" - @echo " qthelp to make HTML files and a qthelp project" - @echo " devhelp to make HTML files and a Devhelp project" - @echo " epub to make an epub" - @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" - @echo " latexpdf to make LaTeX files and run them through pdflatex" - @echo " text to make text files" - @echo " man to make manual pages" - @echo " changes to make an overview of all changed/added/deprecated items" - @echo " linkcheck to check all external links for integrity" - @echo " doctest to run all doctests embedded in the documentation (if enabled)" - -clean: - -rm -rf $(BUILDDIR)/* - -html: - $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html - @echo - @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." - -dirhtml: - $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml - @echo - @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." - -singlehtml: - $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml - @echo - @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml." - -pickle: - $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle - @echo - @echo "Build finished; now you can process the pickle files." - -json: - $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json - @echo - @echo "Build finished; now you can process the JSON files." - -htmlhelp: - $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp - @echo - @echo "Build finished; now you can run HTML Help Workshop with the" \ - ".hhp project file in $(BUILDDIR)/htmlhelp." - -qthelp: - $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp - @echo - @echo "Build finished; now you can run "qcollectiongenerator" with the" \ - ".qhcp project file in $(BUILDDIR)/qthelp, like this:" - @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/DatadogAPI.qhcp" - @echo "To view the help file:" - @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/DatadogAPI.qhc" - -devhelp: - $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp - @echo - @echo "Build finished." - @echo "To view the help file:" - @echo "# mkdir -p $$HOME/.local/share/devhelp/DatadogAPI" - @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/DatadogAPI" - @echo "# devhelp" - -epub: - $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub - @echo - @echo "Build finished. The epub file is in $(BUILDDIR)/epub." - -latex: - $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex - @echo - @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." - @echo "Run \`make' in that directory to run these through (pdf)latex" \ - "(use \`make latexpdf' here to do that automatically)." - -latexpdf: - $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex - @echo "Running LaTeX files through pdflatex..." - make -C $(BUILDDIR)/latex all-pdf - @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." - -text: - $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text - @echo - @echo "Build finished. The text files are in $(BUILDDIR)/text." - -man: - $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man - @echo - @echo "Build finished. The manual pages are in $(BUILDDIR)/man." - -changes: - $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes - @echo - @echo "The overview file is in $(BUILDDIR)/changes." - -linkcheck: - $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck - @echo - @echo "Link check complete; look for any errors in the above output " \ - "or in $(BUILDDIR)/linkcheck/output.txt." - -doctest: - $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest - @echo "Testing of doctests in the sources finished, look at the " \ - "results in $(BUILDDIR)/doctest/output.txt."