Project scaffolding.

CHANGELOG.rst

@@ -0,0 +1,2 @@
+Next Release
+------------

LICENSE

@@ -0,0 +1,27 @@
+Copyright 2021 AWeber Communications, Inc.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its contributors
+   may be used to endorse or promote products derived from this software without
+   specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+

MANIFEST.in

@@ -0,0 +1,4 @@
+graft docs
+graft tests
+include LICENSE
+include CHANGELOG.rst

README.rst

@@ -0,0 +1,5 @@
+Report metrics from your tornado_ web application to a StatsD_ instance.
+
+.. _StatsD: https://github.com/statsd/statsd/
+.. _tornado: https://tornadoweb.org/
+

docs/conf.py

@@ -0,0 +1,20 @@
+import sprockets_statsd
+
+project = 'sprockets-statsd'
+version = sprockets_statsd.version
+copyright = '2021 AWeber Communications, Inc.'
+html_theme = 'pyramid'
+extensions = []
+
+# https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html
+extensions.append('sphinx.ext.autodoc')
+
+# https://www.sphinx-doc.org/en/master/usage/extensions/intersphinx.html
+extensions.append('sphinx.ext.intersphinx')
+intersphinx_mapping = {
+    'python': ('https://docs.python.org/3/', None),
+    'tornado': ('https://www.tornadoweb.org/en/branch6.0/', None),
+}
+
+# https://pypi.org/project/sphinx-autodoc-typehints/
+extensions.append('sphinx_autodoc_typehints')

docs/index.rst

@@ -0,0 +1,13 @@
+================
+sprockets-statsd
+================
+
+.. include:: ../README.rst
+
+Release history
+===============
+
+.. include:: ../CHANGELOG.rst
+
+.. toctree::
+   :maxdepth: 2

setup.cfg

@@ -0,0 +1,68 @@
+[metadata]
+name = sprockets-statsd
+version = attr: sprockets_statsd.version
+description = Asynchronous Statsd connector.
+long_description = file: README.rst
+license = BSD 3-Clause License
+url = https://sprockets-statsd.readthedocs.io/
+project_urls:
+    Bug Tracker = https://github.com/sprockets/sprockets-statsd/issues/
+    Documentation = https://sprockets-statsd.readthedocs.io/
+    Source Code = https://github.com/sprockets/sprockets-statsd/
+author = Dave Shawley
+author_email = daveshawley@gmail.com
+classifiers =
+    Development Status :: 1 - Planning
+    Indended Audience :: Developers
+    License :: OSI Approved :: BSD License
+    Natural Language :: English
+    Operating System :: OS Independent
+    Programming Language :: Python :: 3
+    Programming Language :: Python :: 3 :: Only
+    Programming Language :: Python :: 3.7
+    Programming Language :: Python :: 3.9
+    Topic :: Communications
+    Topic :: Internet
+    Topic :: Software Development
+    Typing :: Typed
+
+[options]
+packages = find:
+install_requires =
+    tornado
+
+[options.extras_require]
+dev =
+    coverage
+    flake8
+    flake8-import-order
+    sphinx
+    sphinx-autodoc-typehints
+    tox
+    yapf
+
+[options.packages.find]
+exclude =
+    tests
+
+[build_sphinx]
+build_dir = build/sphinx
+nitpicky = 1
+warning_is_error = 1
+
+[coverage:report]
+fail_under = 100
+show_missing = 1
+
+[coverage:run]
+branch = 1
+source = sprockets_statsd
+
+[flake8]
+application_import_names = statsd
+exclude = build,env,dist
+import_order_style = pycharm
+
+[yapf]
+allow_split_before_dict_value = false
+indent_dictionary_value = true

setup.py

@@ -0,0 +1,3 @@
+#!/usr/bin/env python
+import setuptools
+setuptools.setup()

sprockets_statsd/__init__.py

@@ -0,0 +1,2 @@
+version_info = (0, 0, 0)
+version = '.'.join(str(c) for c in version_info)