{
    "info": {
        "author": "author",
        "author_email": "author AT something.any",
        "bugtrack_url": null,
        "classifiers": [
            "Development Status :: 5 - Production/Stable",
            "Intended Audience :: Developers",
            "License :: OSI Approved :: MIT License",
            "Programming Language :: Python :: 3",
            "Topic :: Education",
            "Topic :: Scientific/Engineering"
        ],
        "description": ".. _l-README:\n\nREADME / Changes\n================\n\n.. image:: https://travis-ci.org/sdpython/python3_module_template.svg?branch=master\n    :target: https://travis-ci.org/sdpython/python3_module_template\n    :alt: Build status\n    \n.. image:: https://ci.appveyor.com/api/projects/status/6qp50sxl22aqwtb5?svg=true\n    :target: https://ci.appveyor.com/project/sdpython/python3-module-template\n    :alt: Build Status Windows\n    \n.. image:: https://badge.fury.io/py/project_name.svg\n    :target: http://badge.fury.io/py/project_name    \n\n.. image:: http://img.shields.io/pypi/dm/project_name.png\n    :alt: PYPI Package\n    :target: https://pypi.python.org/pypi/project_name\n\n.. image:: http://img.shields.io/github/issues/sdpython/python3_module_template.png\n    :alt: GitHub Issues\n    :target: https://github.com/sdpython/python3_module_template/issues\n    \n.. image:: https://img.shields.io/badge/license-MIT-blue.svg\n    :alt: MIT License\n    :target: http://opensource.org/licenses/MIT\n    \n.. image:: https://coveralls.io/repos/sdpython/python3_module_template/badge.svg?branch=master&service=github \n    :target: https://coveralls.io/github/sdpython/python3_module_template?branch=master     \n\n.. image:: https://landscape.io/github/sdpython/python3_module_template/master/landscape.svg?style=flat\n   :target: https://landscape.io/github/sdpython/python3_module_template/master\n   :alt: Code Health\n   \n.. image:: https://requires.io/github/sdpython/python3_module_template/requirements.svg?branch=master\n     :target: https://requires.io/github/sdpython/python3_module_template/requirements/?branch=master\n     :alt: Requirements Status   \n    \n.. image:: https://codecov.io/github/sdpython/python3_module_template/coverage.svg?branch=master\n    :target: https://codecov.io/github/sdpython/python3_module_template?branch=master\n    \n      \n\n**Links:**\n\n* `GitHub/python3_module_template <https://github.com/sdpython/python3_module_template/>`_\n* `documentation <http://www.xavierdupre.fr/site2013/index_code.html#python3_module_template>`_\n* `Blog <http://www.xavierdupre.fr/app/python3_module_template/helpsphinx/blog/main_0000.html#ap-main-0>`_\n\n\n\nIntroduction\n------------\n\nThis project is a skeleton for any new project. It contains:\n\n* a source folder: ``src``\n* a unit test folder: ``_unittests``, go to this folder and run ``run_unittests.py``\n* a _doc folder: ``_doc``, it will contains the documentation\n* a file ``setup.py`` to build and to install the module\n    \nAll theses steps were only tested on Windows. Suppot for linux will be added later. \nTo create your own project, you need to rename the folder ``project_name`` in ``src`` \nby your true module name. You also need to replace ``project_name`` wherever it is found:\n\n* ``project_var_name  = 'project_name'`` in ``setup.py``, ``make_help.py`` and ``_doc/sphinxdoc/source/conf.py``\n* ``from src.project_name.subproject.myexample import myclass`` in ``_unittests/ut_example/test_example.py``\n* many places in ``_doc/sphinxdoc/source/index.rst``\n* many places in ``README.rst``\n    \nThe project is also hosted `here <http://www.xavierdupre.fr/site2013/index_code.html>`_ \nwhere you can find a \n`link <http://www.xavierdupre.fr/app/python3_module_template/helpsphinx/index.html>`_ \nto the generated documentation based on this template.\n    \nAutomation\n----------\n\n* `Generating the setup with pyquickhelper <http://www.xavierdupre.fr/app/pyquickhelper/helpsphinx/generatesetup.html>`_\n* `Generating the documention with pyquickhelper <http://www.xavierdupre.fr/app/pyquickhelper/helpsphinx/generatedoc.html>`_\n* `Installation <http://www.xavierdupre.fr/app/pyquickhelper/helpsphinx/installation.html>`_\n* `Unit tests with pyquickhelper <http://www.xavierdupre.fr/app/pyquickhelper/helpsphinx/doctestunit.html>`_\n\nAdding a new module or subpackage\n+++++++++++++++++++++++++++++++++\n\nAny new module or subpackage should be added in ``src/project_name``. Every subfolder should\ncontain a file ``__init__.py``. If the new file needs an existing submodule, you need\nto add something like the following::\n\n    import os,sys\n\n    from ..subproject.myexample import myclass\n    \nYou should use relative imports as much as possible.\nTo add a module at deeper level than the previous one, you\nshould add relative imports in every ``__init__.py`` along the way.\n\n\nVersions\n--------\n\n* **0.2 - 2016/??/??**\n    * **change:** update for pyquickhelper >= 1.4\n\n* **0.1 - 2016/03/26**\n    * **new:** first version\n    * **fix:** the setup does not need the file ``README.rst`` anymore\n    * **add:** unit test to check the file ``README.rst`` follows the syntax of docutils 0.8 (for pipy)\n    * **add:** add a unit test to run all notebooks offlines",
        "description_content_type": null,
        "docs_url": null,
        "download_url": "https://github.com/.../",
        "downloads": {
            "last_day": -1,
            "last_month": -1,
            "last_week": -1
        },
        "home_page": "http://...",
        "keywords": "project_name,first name,last name",
        "license": "UNKNOWN",
        "maintainer": null,
        "maintainer_email": null,
        "name": "project_name",
        "package_url": "https://pypi.org/project/project_name/",
        "platform": "UNKNOWN",
        "project_url": "https://pypi.org/project/project_name/",
        "project_urls": {
            "Download": "https://github.com/.../",
            "Homepage": "http://..."
        },
        "release_url": "https://pypi.org/project/project_name/0.2.175/",
        "requires_dist": null,
        "requires_python": null,
        "summary": "This a project template including a setup and the generation of sphinx\ngeneration. The documentation generation is using pyquickhelper.",
        "version": "0.2.175"
    },
    "last_serial": 2416462,
    "releases": {
        "0.2.175": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "90b27376e876fe4a09d709636365658b",
                    "sha256": "8bc4908ea8188434e81359fde64348786370ad77057a8eb402b83902d350ea36"
                },
                "downloads": -1,
                "filename": "project_name-0.2.175-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "90b27376e876fe4a09d709636365658b",
                "packagetype": "bdist_wheel",
                "python_version": "3.4",
                "requires_python": null,
                "size": 9672,
                "upload_time": "2016-03-27T02:31:36",
                "url": "https://files.pythonhosted.org/packages/79/a6/f03a472621f545f4eb16bacbd20765dd18114e4ace7452aa9a0cff13b6fc/project_name-0.2.175-py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "b1997334099bb87c3997efca0d026ca8",
                    "sha256": "1e9c16e98afcc992fc32ba0741ec0edd5db4887f63a22e3fe44d0b8dfd0c29ef"
                },
                "downloads": -1,
                "filename": "project_name-0.2.175.tar.gz",
                "has_sig": false,
                "md5_digest": "b1997334099bb87c3997efca0d026ca8",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 6684,
                "upload_time": "2016-03-27T02:31:18",
                "url": "https://files.pythonhosted.org/packages/50/65/51e2cf7add30c83ebcaf3a0061152f91d3ca2795b6609a4f1a3abbbda871/project_name-0.2.175.tar.gz"
            }
        ]
    },
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "90b27376e876fe4a09d709636365658b",
                "sha256": "8bc4908ea8188434e81359fde64348786370ad77057a8eb402b83902d350ea36"
            },
            "downloads": -1,
            "filename": "project_name-0.2.175-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "90b27376e876fe4a09d709636365658b",
            "packagetype": "bdist_wheel",
            "python_version": "3.4",
            "requires_python": null,
            "size": 9672,
            "upload_time": "2016-03-27T02:31:36",
            "url": "https://files.pythonhosted.org/packages/79/a6/f03a472621f545f4eb16bacbd20765dd18114e4ace7452aa9a0cff13b6fc/project_name-0.2.175-py3-none-any.whl"
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "b1997334099bb87c3997efca0d026ca8",
                "sha256": "1e9c16e98afcc992fc32ba0741ec0edd5db4887f63a22e3fe44d0b8dfd0c29ef"
            },
            "downloads": -1,
            "filename": "project_name-0.2.175.tar.gz",
            "has_sig": false,
            "md5_digest": "b1997334099bb87c3997efca0d026ca8",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 6684,
            "upload_time": "2016-03-27T02:31:18",
            "url": "https://files.pythonhosted.org/packages/50/65/51e2cf7add30c83ebcaf3a0061152f91d3ca2795b6609a4f1a3abbbda871/project_name-0.2.175.tar.gz"
        }
    ]
}