.zenodo.json

{
    "title": "CI/CD examples to test and deploy python packages from Github",
    "description": "<p>Python project to showcase how to hook Github with:</p><ul><li>Read the Docs</li><li>Travis CI</li><li>Codecov</li><li>Coveralls</li><li>PyPI</li><li>Anaconda</li><li>Github Pages</li><li>Github Releases</li><li>Zenodo</li></ul><p>See <a href=\"https://github.com/seignovert/test-python-docs/blob/master/setup.cfg\">setup.cfg</a> to configure:</p><ul><li>package description (name, author, url, files…).</li><li>PyPI deploy settings.</li><li>Pytest options.</li><li>Coverage report settings.</li><li>Linter settings.</li></ul><p>See <a href=\"https://github.com/seignovert/test-python-docs/blob/master/tox.ini\">tox.ini</a> to configure:</p><ul><li>module tests from <em>tests/</em> folder (with <cite>pytest</cite>).</li><li>module coverage (from <cite>pytest</cite> output).</li><li>documentation build from <em>docs/</em> folder (with <cite>sphinx</cite>, <cite>autodoc</cite> and <cite>napoleon</cite>).</li><li>documentation tests from <em>docs/*.rst</em> files and docstrings in <em>foo</em> module.</li><li>linter python files syntax (with <cite>flake8</cite>).</li></ul><p>See <a href=\"https://github.com/seignovert/test-python-docs/blob/master/meta.yaml\">meta.yaml</a> of Anaconda recipe.</p><p>See <a href=\"https://github.com/seignovert/test-python-docs/blob/master/.readthedocs.yml\">.readthedocs.yml</a> to configure <a href=\"https://test-python-docs.readthedocs.io/\">Read the Docs</a> deployment.</p><p>See <a href=\"https://github.com/seignovert/test-python-docs/blob/master/.travis.yml\">.travis.yml</a> to configure CI tests and deployments to:</p><ul><li><a href=\"https://codecov.io/gh/seignovert/test-python-docs\">Codecov</a></li><li><a href=\"https://coveralls.io/github/seignovert/test-python-docs\">Coveralls</a></li><li><a href=\"https://test.pypi.org/project/foo-autodeploy/\">PyPI (test)</a></li><li><a href=\"https://anaconda.org/seignovert/foo-autodeploy\">Anaconda</a></li><li><a href=\"https://github.com/seignovert/test-python-docs/releases\">Github Releases</a></li><li><a href=\"https://seignovert.github.io/test-python-docs/\">Github Pages</a></li></ul><p>See <a href=\"https://github.com/seignovert/test-python-docs/blob/master/.zenodo.json\">.zenodo.json</a> to configure <a href=\"https://zenodo.org\">Zenodo</a> deployment, to get a DOI for each <a href=\"https://guides.github.com/activities/citable-code/\">Github release</a>.</p><p>(Note: in this test case, we hook our release with Zenodo sandbox interface to avoid dummy publications, therefore the DOI badge is not valid but the record can be found <a href=\"https://sandbox.zenodo.org/record/257354\">here</a>).</p><strong>Sphinx autobuild (tip)</strong><p>Install:</p><pre><code>$ pip install sphinx-autobuild</code></pre><p>Start autobuild (with live reload):</p><pre><code>$ cd docs ; make livehtml</code></pre>",
    "license": "MIT",
    "upload_type": "software",
    "access_right": "open",
    "creators": [
        {
            "name": "Seignovert, Benoît",
            "orcid": "0000-0001-6533-275X"
        }
    ],
    "keywords": [
        "python",
        "docs",
        "test"
    ]
}