Initial commit

.gitignore

@@ -0,0 +1,57 @@
+# Add any project-specific files here:
+
+
+# Sphinx docs
+docs/build/
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*~
+\#*
+.#*
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+/build/
+/develop-eggs/
+/dist/
+/eggs/
+/lib/
+/lib64/
+/parts/
+/sdist/
+/var/
+*.egg-info/
+.installed.cfg
+*.egg
+
+# Installer logs
+pip-log.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+
+# Translations
+*.mo
+
+# Mr Developer
+.mr.developer.cfg
+.project
+.pydevproject
+
+# Rope
+.ropeproject
+
+# Django stuff:
+*.log
+*.pot

LICENSE

@@ -0,0 +1,121 @@
+Creative Commons Legal Code
+
+CC0 1.0 Universal
+
+    CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE
+    LEGAL SERVICES. DISTRIBUTION OF THIS DOCUMENT DOES NOT CREATE AN
+    ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS
+    INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES
+    REGARDING THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS
+    PROVIDED HEREUNDER, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM
+    THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED
+    HEREUNDER.
+
+Statement of Purpose
+
+The laws of most jurisdictions throughout the world automatically confer
+exclusive Copyright and Related Rights (defined below) upon the creator
+and subsequent owner(s) (each and all, an "owner") of an original work of
+authorship and/or a database (each, a "Work").
+
+Certain owners wish to permanently relinquish those rights to a Work for
+the purpose of contributing to a commons of creative, cultural and
+scientific works ("Commons") that the public can reliably and without fear
+of later claims of infringement build upon, modify, incorporate in other
+works, reuse and redistribute as freely as possible in any form whatsoever
+and for any purposes, including without limitation commercial purposes.
+These owners may contribute to the Commons to promote the ideal of a free
+culture and the further production of creative, cultural and scientific
+works, or to gain reputation or greater distribution for their Work in
+part through the use and efforts of others.
+
+For these and/or other purposes and motivations, and without any
+expectation of additional consideration or compensation, the person
+associating CC0 with a Work (the "Affirmer"), to the extent that he or she
+is an owner of Copyright and Related Rights in the Work, voluntarily
+elects to apply CC0 to the Work and publicly distribute the Work under its
+terms, with knowledge of his or her Copyright and Related Rights in the
+Work and the meaning and intended legal effect of CC0 on those rights.
+
+1. Copyright and Related Rights. A Work made available under CC0 may be
+protected by copyright and related or neighboring rights ("Copyright and
+Related Rights"). Copyright and Related Rights include, but are not
+limited to, the following:
+
+  i. the right to reproduce, adapt, distribute, perform, display,
+     communicate, and translate a Work;
+ ii. moral rights retained by the original author(s) and/or performer(s);
+iii. publicity and privacy rights pertaining to a person's image or
+     likeness depicted in a Work;
+ iv. rights protecting against unfair competition in regards to a Work,
+     subject to the limitations in paragraph 4(a), below;
+  v. rights protecting the extraction, dissemination, use and reuse of data
+     in a Work;
+ vi. database rights (such as those arising under Directive 96/9/EC of the
+     European Parliament and of the Council of 11 March 1996 on the legal
+     protection of databases, and under any national implementation
+     thereof, including any amended or successor version of such
+     directive); and
+vii. other similar, equivalent or corresponding rights throughout the
+     world based on applicable law or treaty, and any national
+     implementations thereof.
+
+2. Waiver. To the greatest extent permitted by, but not in contravention
+of, applicable law, Affirmer hereby overtly, fully, permanently,
+irrevocably and unconditionally waives, abandons, and surrenders all of
+Affirmer's Copyright and Related Rights and associated claims and causes
+of action, whether now known or unknown (including existing as well as
+future claims and causes of action), in the Work (i) in all territories
+worldwide, (ii) for the maximum duration provided by applicable law or
+treaty (including future time extensions), (iii) in any current or future
+medium and for any number of copies, and (iv) for any purpose whatsoever,
+including without limitation commercial, advertising or promotional
+purposes (the "Waiver"). Affirmer makes the Waiver for the benefit of each
+member of the public at large and to the detriment of Affirmer's heirs and
+successors, fully intending that such Waiver shall not be subject to
+revocation, rescission, cancellation, termination, or any other legal or
+equitable action to disrupt the quiet enjoyment of the Work by the public
+as contemplated by Affirmer's express Statement of Purpose.
+
+3. Public License Fallback. Should any part of the Waiver for any reason
+be judged legally invalid or ineffective under applicable law, then the
+Waiver shall be preserved to the maximum extent permitted taking into
+account Affirmer's express Statement of Purpose. In addition, to the
+extent the Waiver is so judged Affirmer hereby grants to each affected
+person a royalty-free, non transferable, non sublicensable, non exclusive,
+irrevocable and unconditional license to exercise Affirmer's Copyright and
+Related Rights in the Work (i) in all territories worldwide, (ii) for the
+maximum duration provided by applicable law or treaty (including future
+time extensions), (iii) in any current or future medium and for any number
+of copies, and (iv) for any purpose whatsoever, including without
+limitation commercial, advertising or promotional purposes (the
+"License"). The License shall be deemed effective as of the date CC0 was
+applied by Affirmer to the Work. Should any part of the License for any
+reason be judged legally invalid or ineffective under applicable law, such
+partial invalidity or ineffectiveness shall not invalidate the remainder
+of the License, and in such case Affirmer hereby affirms that he or she
+will not (i) exercise any of his or her remaining Copyright and Related
+Rights in the Work or (ii) assert any associated claims and causes of
+action with respect to the Work, in either case contrary to Affirmer's
+express Statement of Purpose.
+
+4. Limitations and Disclaimers.
+
+ a. No trademark or patent rights held by Affirmer are waived, abandoned,
+    surrendered, licensed or otherwise affected by this document.
+ b. Affirmer offers the Work as-is and makes no representations or
+    warranties of any kind concerning the Work, express, implied,
+    statutory or otherwise, including without limitation warranties of
+    title, merchantability, fitness for a particular purpose, non
+    infringement, or the absence of latent or other defects, accuracy, or
+    the present or absence of errors, whether or not discoverable, all to
+    the greatest extent permissible under applicable law.
+ c. Affirmer disclaims responsibility for clearing rights of other persons
+    that may apply to the Work or any use thereof, including without
+    limitation any person's Copyright and Related Rights in the Work.
+    Further, Affirmer disclaims responsibility for obtaining any necessary
+    consents, permissions or other rights required for any use of the
+    Work.
+ d. Affirmer understands and acknowledges that Creative Commons is not a
+    party to this document and has no duty or obligation with respect to
+    this CC0 or use of the Work.

README.rst

@@ -0,0 +1,53 @@
+cookiecutter-trio
+=================
+
+This is a cookiecutter template for Python projects using `Trio
+<https://trio.readthedocs.io>`__. It makes it easy to start a new
+project.
+
+You don't have to use this – Trio's just an ordinary Python package
+that you can use like any other, and if you already have a preferred
+way of setting up Python projects, then go for it. But using this
+template sets up a number of handy things:
+
+* pytest with trio integration
+* sphinx docs with sphinxcontrib-trio enabled
+* Readthedocs to publish your docs
+* Using Travis and Appveyor to test your package on all the different
+  platforms Trio supports: Windows + MacOS + Linux, CPython + PyPy
+* Codecov to track code coverage information
+* towncrier for easy release note management
+* yapf so you don't have to think about formatting
+
+This is the same setup used to develop Trio itself and many related
+projects, so using it makes it easy for new contributors to get
+started.
+
+
+XX ughhh what are we going to do about in-tree tests vs. out-of-tree
+tests.
+
+
+Let's do this!
+--------------
+
+1. ``pip install -U cookiecutter`` (or check out the `detailed
+   cookiecutter install instructions
+   <https://cookiecutter.readthedocs.io/en/latest/installation.html>`__)
+2. ``cookiecutter gh:python-trio/cookiecutter-trio``
+3. Answer the questions. This will create a directory named after your
+   project (e.g., if you said your project is called
+   ``superwhizbang``, then there will be a directory called
+   ``superwhizbang/``).
+4. Look through ``{your project}/NEW-PROJECT-TODO.rst`` for a
+   checklist of things to think about.
+
+
+License
+-------
+
+This cookiecutter template is released under the CC0 Public Domain
+Dedication – see the file LICENSE for details. Basically what this
+means is that you can use it for any kind of project you want under
+whatever license terms you want, and you don't even have to worry
+about giving us credit or anything like that.

cookiecutter.json

@@ -0,0 +1,124 @@
+{
+    "full_name": "Your name",
+    "email": "Your address email (eq. you@example.com)",
+    "project_name": "Name of the project",
+    "project_slug": "{{ cookiecutter.project_name.lower().replace(' ', '-') }}",
+    "package_name": "{{ cookiecutter.project_slug.replace('-', '_') }}",
+    "project_short_description": "A short description of the project (for setup.py metadata)",
+    "project_url": "Project URL (for setup.py metadata)",
+    "license": [
+        "Dual MIT/Apache 2 (like Trio)",
+        "GPLv3 or later",
+        "Other"
+    ],
+    "test_on_linux": "y",
+    "test_on_macos": "y",
+    "test_on_windows": "y",
+    "test_on_cpython_35": "y",
+    "test_on_cpython_36": "y",
+    "test_on_pypy3": "y",
+    "test_on_python_prereleases": "y",
+
+    "_comment": [
+        "The above license strings are for users to look at. They're not",
+        "super friendly for programs. So the rest of the cookiecutter never",
+        "uses them directly, but only as keys into this table:"
+    ],
+    "_license_info": {
+        "Dual MIT/Apache 2 (like Trio)": {
+            "slug": "dual-mit-apache2",
+            "readme": "Your choice of MIT or Apache License 2.0",
+            "license_field": "MIT -or- Apache License 2.0",
+            "trove": [
+                "License :: OSI Approved :: MIT License",
+                "License :: OSI Approved :: Apache Software License"
+            ]
+        },
+        "GPLv3 or later": {
+            "slug": "gplv3+",
+            "readme": "GPLv3 as published by the Free Software Foundation, or (at your option) any later version",
+            "license_field": "GPLv3 or later",
+            "trove": [
+                "License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)"
+            ]
+        },
+        "Other": {
+            "slug": "other",
+            "readme": "<COOKIECUTTER-TRIO-TODO: fill me in!>",
+            "license_field": "<COOKIECUTTER-TRIO-TODO: fill me in!>",
+            "trove": [
+            ]
+        }
+    },
+
+    "_comment": "https://docs.microsoft.com/en-us/visualstudio/python/cookiecutter#optimizing-cookiecutter-templates-for-visual-studio",
+    "_visual_studio": {
+        "full_name": {
+            "label": "Full name",
+            "description": "Your full name (for setup.py metadata)"
+        },
+        "email": {
+            "label": "Email",
+            "description": "Your email (for setup.py metadata)"
+        },
+        "project_name": {
+            "label": "Project name",
+            "description": "Name of the project (for human text, like docs)"
+        },
+        "project_slug": {
+            "label": "Project slug",
+            "description": "Name of the project (for 'pip install <...>')"
+        },
+        "package_name": {
+            "label": "Package name",
+            "description": "Name of the package (for 'import <...>')"
+        },
+        "project_short_description": {
+            "label": "Project short description",
+            "descripton": "One line (for setup.py metadata)"
+        },
+        "project_url": {
+            "label": "Project URL",
+            "descripton": "(for setup.py metadata)"
+        },
+        "license": {
+            "label": "License"
+        },
+        "test_on_linux": {
+            "label": "Run tests on Linux (using Travis)?",
+            "selector": "yesno"
+        },
+        "test_on_macos": {
+            "label": "Run tests on MacOS (using Travis)?",
+            "selector": "yesno"
+        },
+        "test_on_windows": {
+            "label": "Run tests on Windows (using Appveyor)?",
+            "selector": "yesno"
+        },
+        "test_on_cpython_35": {
+            "label": "Run tests on CPython 3.5?",
+            "selector": "yesno"
+        },
+        "test_on_cpython_36": {
+            "label": "Run tests on CPython 3.6?",
+            "selector": "yesno"
+        },
+        "test_on_pypy3": {
+            "label": "Run tests on PyPy3?",
+            "selector": "yesno"
+        },
+        "test_on_python_prereleases": {
+            "label": "Run tests on Python prereleases?",
+            "selector": "yesno"
+        }
+    },
+    "_visual_studio_post_cmds": [
+        {
+            "name": "File.OpenFile",
+            "args": [
+                "{{ cookiecutter._output_folder_path }}\\CHEATSHEET.rst"
+            ]
+        }
+    ]
+}

license-files/dual-mit-apache2/LICENSE

@@ -0,0 +1 @@
+This software is made available under the terms of *either* of the licenses found in LICENSE.APACHE2 or LICENSE.MIT. Contributions to are made under the terms of *both* these licenses.