coverage process

.eggs/PyScaffold-3.2.3-py3.9.egg/EGG-INFO/AUTHORS.rst

@@ -0,0 +1,23 @@
+============
+Contributors
+============
+
+* Florian Wilhelm
+* Felix Wick
+* Holger Peters
+* Uwe Korn
+* Patrick Mühlbauer
+* Florian Rathgeber
+* Eva Schmücker
+* Tim Werner
+* Julian Gethmann
+* Will Usher
+* Anderson Bravalheri
+* David Hilton
+* Pablo Aguiar
+* Vicky C Lau
+* Reuven Podmazo
+* Juan Leni
+* Anthony Sottile
+* Henning Häcker
+* Noah Pendleton

.eggs/PyScaffold-3.2.3-py3.9.egg/EGG-INFO/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Blue Yonder GmbH
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

.eggs/PyScaffold-3.2.3-py3.9.egg/EGG-INFO/PKG-INFO

@@ -0,0 +1,277 @@
+Metadata-Version: 2.1
+Name: PyScaffold
+Version: 3.2.3
+Summary: Template tool for putting up the scaffold of a Python project
+Home-page: https://github.com/pyscaffold/pyscaffold/
+Author: Florian Wilhelm
+Author-email: Florian.Wilhelm@gmail.com
+License: MIT
+Project-URL: Documentation, https://pyscaffold.org/
+Project-URL: Twitter, https://twitter.com/PyScaffold
+Project-URL: Conda-Forge, https://anaconda.org/conda-forge/pyscaffold
+Platform: any
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Topic :: Utilities
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.4
+Classifier: Programming Language :: Python :: 3.5
+Classifier: Programming Language :: Python :: 3.6
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Operating System :: Unix
+Classifier: Operating System :: MacOS
+Classifier: Operating System :: Microsoft :: Windows
+Requires-Python: >=3.4
+Description-Content-Type: text/x-rst; charset=UTF-8
+Requires-Dist: setuptools (>=38.3)
+Provides-Extra: all
+Requires-Dist: django ; extra == 'all'
+Requires-Dist: cookiecutter ; extra == 'all'
+Requires-Dist: pyscaffoldext-markdown ; extra == 'all'
+Requires-Dist: pyscaffoldext-pyproject ; extra == 'all'
+Requires-Dist: pyscaffoldext-custom-extension ; extra == 'all'
+Requires-Dist: pyscaffoldext-dsproject ; extra == 'all'
+Provides-Extra: ds
+Requires-Dist: pyscaffoldext-dsproject ; extra == 'ds'
+Provides-Extra: md
+Requires-Dist: pyscaffoldext-markdown ; extra == 'md'
+Provides-Extra: testing
+Requires-Dist: sphinx ; extra == 'testing'
+Requires-Dist: flake8 ; extra == 'testing'
+Requires-Dist: pytest ; extra == 'testing'
+Requires-Dist: pytest-cov ; extra == 'testing'
+Requires-Dist: pytest-shutil ; extra == 'testing'
+Requires-Dist: pytest-virtualenv ; extra == 'testing'
+Requires-Dist: pytest-fixture-config ; extra == 'testing'
+Requires-Dist: pytest-xdist ; extra == 'testing'
+
+.. image:: https://api.cirrus-ci.com/github/pyscaffold/pyscaffold.svg?branch=master
+    :alt: Built Status
+    :target: https://cirrus-ci.com/github/pyscaffold/pyscaffold
+.. image:: https://readthedocs.org/projects/pyscaffold/badge/?version=latest
+    :alt: ReadTheDocs
+    :target: https://pyscaffold.org/
+.. image:: https://img.shields.io/coveralls/github/pyscaffold/pyscaffold/master.svg
+    :alt: Coveralls
+    :target: https://coveralls.io/r/pyscaffold/pyscaffold
+.. image:: https://img.shields.io/pypi/v/pyscaffold.svg
+    :alt: PyPI-Server
+    :target: https://pypi.org/project/pyscaffold/
+.. image:: https://img.shields.io/conda/vn/conda-forge/pyscaffold.svg
+    :alt: Conda-Forge
+    :target: https://anaconda.org/conda-forge/pyscaffold
+.. image:: https://img.shields.io/twitter/url/http/shields.io.svg?style=social&label=Follow
+    :alt: Twitter
+    :target: https://twitter.com/pyscaffold
+
+
+|
+
+.. image:: https://pyscaffold.org/en/latest/_images/logo.png
+    :height: 512px
+    :width: 512px
+    :scale: 60 %
+    :alt: PyScaffold logo
+    :align: center
+
+|
+
+PyScaffold helps you setup a new Python project. Just install it with::
+
+        pip install pyscaffold
+
+or if you want to also install all *extensions* with::
+
+        pip install pyscaffold[all]
+
+If you prefer *conda* over *pip*, just install PyScaffold with::
+
+    conda install -c conda-forge pyscaffold
+
+This will give you a new ``putup`` command and you can just type::
+
+    putup my_project
+
+This will create a new folder called ``my_project`` containing a perfect *project
+template* with everything you need for some serious coding. After the usual::
+
+   python setup.py develop
+
+you are all set and ready to go.
+
+Type ``putup -h`` to learn about more configuration options. PyScaffold assumes
+that you have Git_ installed and set up on your PC,
+meaning at least your name and email are configured.
+The project template in ``my_project`` provides you with following features:
+
+
+Configuration & Packaging
+=========================
+
+All configuration can be done in ``setup.cfg`` like changing the description,
+url, classifiers, installation requirements and so on as defined by setuptools_.
+That means in most cases it is not necessary to tamper with ``setup.py``.
+
+In order to build a source, binary or wheel distribution, just run
+``python setup.py sdist``, ``python setup.py bdist`` or
+``python setup.py bdist_wheel`` (recommended).
+
+.. rubric:: Package and Files Data
+
+Additional data, e.g. images and text files, that reside within your package and
+are tracked by Git will automatically be included
+(``include_package_data = True`` in ``setup.cfg``).
+It is not necessary to have a ``MANIFEST.in`` file for this to work.
+
+Versioning and Git Integration
+==============================
+
+Your project is an already initialised Git repository and ``setup.py`` uses
+the information of tags to infer the version of your project with the help of
+setuptools_scm_.
+To use this feature, you need to tag with the format ``MAJOR.MINOR[.PATCH]``
+, e.g. ``0.0.1`` or ``0.1``.
+Run ``python setup.py --version`` to retrieve the current PEP440_-compliant
+version. This version
+will be used when building a package and is also accessible through
+``my_project.__version__``.
+
+Unleash the power of Git by using its `pre-commit hooks`_. This feature is
+available through the ``--pre-commit`` flag. After your project's scaffold
+was generated, make sure pre-commit is installed, e.g. ``pip install pre-commit``,
+then just run ``pre-commit install``.
+
+A default ``.gitignore`` file is also provided; it is
+well adjusted for Python projects and the most common tools.
+
+
+Sphinx Documentation
+====================
+
+Build the documentation with ``python setup.py docs`` and run doctests with
+``python setup.py doctest`` after you have `Sphinx`_ installed.
+Start editing the file ``docs/index.rst`` to extend the documentation.
+The documentation also works with `Read the Docs`_.
+
+The `Numpy and Google style docstrings`_ are activated by default.
+Just make sure Sphinx 1.3 or above is installed.
+
+
+Unittest & Coverage
+===================
+
+Run ``python setup.py test`` to run all unittests defined in the subfolder
+``tests`` with the help of `py.test`_ and pytest-runner_. Some sane
+default flags for py.test are already defined in the ``[tool:pytest]`` section of
+``setup.cfg``. The py.test plugin `pytest-cov`_ is used to automatically
+generate a coverage report. It is also possible to provide additional
+parameters and flags on the commandline, e.g., type::
+
+    python setup.py test --addopts -h
+
+to show the help of py.test.
+
+.. rubric:: JUnit and Coverage HTML/XML
+
+For usage with a continuous integration software JUnit and Coverage XML output
+can be activated in ``setup.cfg``. Use the flag ``--travis`` to generate
+templates of the `Travis`_ configuration files
+``.travis.yml`` and ``tests/travis_install.sh`` which even features the
+coverage and stats system `Coveralls`_.
+In order to use the virtualenv management and test tool `Tox`_ the flag
+``--tox`` can be specified.
+
+
+Management of Requirements & Licenses
+=====================================
+
+Installation requirements of your project can be defined inside ``setup.cfg``,
+e.g. ``install_requires = numpy; scipy``. To avoid package dependency problems,
+it is common to not pin installation requirements to any specific version,
+although minimum versions, e.g. ``sphinx>=1.3``, or maximum versions, e.g.
+``pandas<0.12``, are used sometimes.
+
+More specific installation requirements should go into ``requirements.txt``.
+This file can also be managed with the help of ``pip compile`` from `pip-tools`_
+that basically pins packages to the current version, e.g. ``numpy==1.13.1``.
+The packages defined in ``requirements.txt`` can be easily installed with::
+
+    pip install -r requirements.txt
+
+All licenses from `choosealicense.com`_ can be easily selected with the help
+of the ``--license`` flag.
+
+
+Extensions
+==========
+
+PyScaffold comes with several extensions:
+
+* If you want a project setup for a *Data Science* task, just use ``--dsproject``
+  after having installed `pyscaffoldext-dsproject`_.
+
+* Create a `Django project`_ with the flag ``--django`` which is equivalent to
+  ``django-admin.py startproject my_project`` enhanced by PyScaffold's features.
+
+* Create a template for your own PyScaffold extension with ``--custom-extension``
+  after having installed `pyscaffoldext-custom-extension`_ with ``pip``.
+
+* Have a ``README.md`` based on MarkDown instead of ``README.rst`` by using
+  ``--markdown`` after having installed `pyscaffoldext-markdown`_ with ``pip``.
+
+* Add a ``pyproject.toml`` file according to `PEP 518`_ to your template by using
+  ``--pyproject`` after having installed `pyscaffoldext-pyproject`_ with ``pip``.
+
+* With the help of `Cookiecutter`_ it is possible to further customize your project
+  setup with a template tailored for PyScaffold. Just use the flag ``--cookiecutter TEMPLATE``
+  to use a cookiecutter template which will be refined by PyScaffold afterwards.
+
+* ... and many more like ``--gitlab`` to create the necessary files for GitLab_.
+
+Find more extensions within the `PyScaffold organisation`_ and consider contributing your own.
+All extensions can easily be installed with ``pip pyscaffoldext-NAME``.
+
+Easy Updating
+=============
+
+Keep your project's scaffold up-to-date by applying
+``putup --update my_project`` when a new version of PyScaffold was released.
+An update will only overwrite files that are not often altered by users like
+``setup.py``. To update all files use ``--update --force``.
+An existing project that was not setup with PyScaffold can be converted with
+``putup --force existing_project``. The force option is completely safe to use
+since the git repository of the existing project is not touched!
+
+
+.. _setuptools: http://setuptools.readthedocs.io/en/latest/setuptools.html#configuring-setup-using-setup-cfg-files
+.. _setuptools_scm: https://pypi.python.org/pypi/setuptools_scm/
+.. _Git: http://git-scm.com/
+.. _PEP440: http://www.python.org/dev/peps/pep-0440/
+.. _pre-commit hooks: http://pre-commit.com/
+.. _py.test: http://pytest.org/
+.. _Sphinx: http://www.sphinx-doc.org/
+.. _Read the Docs: https://readthedocs.org/
+.. _Numpy and Google style docstrings: http://www.sphinx-doc.org/en/master/usage/extensions/napoleon.html
+.. _pytest-runner: https://pypi.python.org/pypi/pytest-runner
+.. _pytest-cov: https://github.com/schlamar/pytest-cov
+.. _Travis: https://travis-ci.org
+.. _Coveralls: https://coveralls.io/
+.. _Tox: https://tox.readthedocs.org/
+.. _choosealicense.com: http://choosealicense.com/
+.. _Django project: https://www.djangoproject.com/
+.. _Cookiecutter: https://cookiecutter.readthedocs.org/
+.. _GitLab: https://about.gitlab.com/
+.. _pip-tools: https://github.com/jazzband/pip-tools/
+.. _pyscaffoldext-dsproject: https://github.com/pyscaffold/pyscaffoldext-dsproject
+.. _pyscaffoldext-custom-extension: https://github.com/pyscaffold/pyscaffoldext-custom-extension
+.. _pyscaffoldext-markdown: https://github.com/pyscaffold/pyscaffoldext-markdown
+.. _pyscaffoldext-pyproject: https://github.com/pyscaffold/pyscaffoldext-pyproject
+.. _PEP 518: https://www.python.org/dev/peps/pep-0518/
+.. _PyScaffold organisation: https://github.com/pyscaffold/
+
+