{ "info": { "author": "Lennart Schueler", "author_email": "mostem@posteo.org", "bugtrack_url": null, "classifiers": [ "Development Status :: 5 - Production/Stable", "Intended Audience :: Developers", "License :: OSI Approved :: GNU General Public License v3 (GPLv3)", "Natural Language :: English", "Operating System :: Unix", "Programming Language :: Python", "Programming Language :: Python :: 3", "Topic :: Utilities" ], "description": "# Python-Deployment\n\n[![Documentation Status](https://readthedocs.org/projects/docs/badge/?version=latest)](https://python-deployment.readthedocs.io/en/latest/)\n\nExamples of Python Deployment Workflows\n\n\n## Documentation with Sphinx and Read the Docs\n\n### Setting up Sphinx\n\nIn order to generate a documentation from the docstrings we are going to use\nSphinx.\n\n1. Create a `docs` directory in your projects main directory.\n\n```bash\nmkdir docs\ncd docs\n```\n\n2. Use the quickstart script provided by Sphinx.\n\n```\nsphinx-quickstart\n```\n\nAnd use the following settings.\n\n

\n\"sphinx-quickstart\"\n

\n\n3. Change `source/conf.py`. The first thing to do is to uncomment and change\nfollowing lines at the top of the file.\n\n```python\nimport os\nimport sys\nsys.path.insert(0, os.path.abspath('../../'))\n```\n\nA few extra extensions should also be added. The `autosummary` extension\ngenerates function/method/attribute summary lists from the docstrings,\n`napoleon` enables Sphinx to parse Numpy and Google style docstrings.\nFinally, the `numpydoc` extension loads several extensions for better\nsupport of Numpy.\n\n```python\nextensions = ['sphinx.ext.autodoc',\n 'sphinx.ext.intersphinx',\n 'sphinx.ext.coverage',\n 'sphinx.ext.imgmath',\n 'sphinx.ext.ifconfig',\n 'sphinx.ext.viewcode',\n 'sphinx.ext.autosummery',\n 'sphinx.ext.napoleon',\n 'numpydoc']\n```\nAnd some more changes:\n- `master_doc = 'contents'` for a better overview page,\nwhich we will later add.\n- `html_style = 'sphinx_rtd_theme'` for a nicer theme.\n- For compatibility with Read the Docs:\n\n```python\nhtml_theme_options = {\n # 'canonical_url': '',\n # 'analytics_id': '',\n 'logo_only': False,\n 'display_version': True,\n 'prev_next_buttons_location': \"top\",\n # 'style_external_links': False,\n # 'vcs_pageview_mode': '',\n # Toc options\n 'collapse_navigation': False,\n 'sticky_navigation': True,\n 'navigation_depth': 4,\n 'includehidden': True,\n 'titles_only': False,\n}\n```\n- Comment out `# html_static_path = ['_static']`\n- In case you use pictures hosted somewhere, add\n```python\nsuppress_warnings = [\n \"image.nonlocal_uri\",\n # 'app.add_directive', # this evtl. suppresses the numpydoc induced warning\n]\n```\n- And finally add some intersphinx mappings for links:\n```python\nintersphinx_mapping = {\n \"Python 3.7\": (\"https://docs.python.org/3.6\", None),\n \"Python\": (\"https://docs.python.org/\", None),\n \"NumPy\": (\"http://docs.scipy.org/doc/numpy/\", None),\n \"SciPy\": (\"http://docs.scipy.org/doc/scipy/reference\", None),\n \"matplotlib\": (\"http://matplotlib.org\", None),\n}\n```\n\nNow you are ready to create your docs. Have a look at the `docs/source/`\nfolder for an example and how to use autosummary in the source files.\n\n\n### Publishing on Read the Docs\n\n\n1. In the `docs/` folder create a file `requirements.txt` with a content like\n\n```python\nnumpy>=1.14.5\nnumpydoc\n```\n2. Log in or sign up on [Read the Docs](https://readthedocs.org)\n3. Click on `Import a Project` and select your repository on GitHub and\nactivate advanced options.\n4. Select Python as the programming language.\n5. Add `docs/requirements.txt` path to the `Requirements file` field.\n6. Tick `Use system packages`.\n\nNow, your documentation should be ready and hosted on\n[Read the Docs](https://readthedocs.org). With every push to your\nrepo, the documentation will automatically be built by Read the Docs.\n\nIn case you want to add a readthedocs badge, have a look at the first\nline after the heading of the `README.md` of this project.\n\n\n", "description_content_type": "text/markdown", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/LSchueler/Python-Deployment", "keywords": "", "license": "GPL - see LICENSE", "maintainer": "Lennart Schueler", "maintainer_email": "mostem@posteo.org", "name": "python-deployment", "package_url": "https://pypi.org/project/python-deployment/", "platform": "Windows", "project_url": "https://pypi.org/project/python-deployment/", "project_urls": { "Homepage": "https://github.com/LSchueler/Python-Deployment" }, "release_url": "https://pypi.org/project/python-deployment/0.0.1/", "requires_dist": [ "numpy (>=1.14.5)" ], "requires_python": "", "summary": "Python Deployment", "version": "0.0.1" }, "last_serial": 5332284, "releases": { "0.0.1": [ { "comment_text": "", "digests": { "md5": "74cf1b02b707f4d7be4a567031050b34", "sha256": "95f41f6550ec4f9f8b10d3cdd69e279bf0fbad52e3bdb572b46240e4d4c5fac9" }, "downloads": -1, "filename": "python_deployment-0.0.1-cp27-cp27m-manylinux1_i686.whl", "has_sig": false, "md5_digest": "74cf1b02b707f4d7be4a567031050b34", "packagetype": "bdist_wheel", "python_version": "cp27", "requires_python": null, "size": 378368, "upload_time": "2019-05-29T12:49:44", "url": "https://files.pythonhosted.org/packages/aa/59/d51c680c5ca2b8f66ad28ee2476dc8918b0a7df804b67eb4a4231ad1d141/python_deployment-0.0.1-cp27-cp27m-manylinux1_i686.whl" }, { "comment_text": "", "digests": { "md5": "5d0683c7e8a9c93fbf176669e368ae7b", "sha256": "4272985f7682022707c48308a3e42fd8fd84876484e29ee66b24a72b6044bed2" }, "downloads": -1, "filename": "python_deployment-0.0.1-cp27-cp27m-manylinux1_x86_64.whl", "has_sig": false, "md5_digest": "5d0683c7e8a9c93fbf176669e368ae7b", "packagetype": "bdist_wheel", "python_version": "cp27", "requires_python": null, "size": 395971, "upload_time": "2019-05-29T12:49:46", "url": "https://files.pythonhosted.org/packages/ab/ea/f824e8c77da70e0d0d9af3e268045756c9351e4fa788bf51871270443ca1/python_deployment-0.0.1-cp27-cp27m-manylinux1_x86_64.whl" }, { "comment_text": "", "digests": { "md5": "32abc46b36288e89912b15d0f1ec8da9", "sha256": "016f3aeec0b337ea1da150ef8d61eb56974fdad2a26e9f53abb741e7c719e6c3" }, "downloads": -1, "filename": "python_deployment-0.0.1-cp27-cp27mu-manylinux1_i686.whl", "has_sig": false, "md5_digest": "32abc46b36288e89912b15d0f1ec8da9", "packagetype": "bdist_wheel", "python_version": "cp27", "requires_python": null, "size": 378426, "upload_time": "2019-05-29T12:49:48", "url": "https://files.pythonhosted.org/packages/91/27/deff1e05a8cf2dc41c7eaf7b394b3b7a42b4f75a0e1904a4b091a7c3ec05/python_deployment-0.0.1-cp27-cp27mu-manylinux1_i686.whl" }, { "comment_text": "", "digests": { "md5": "bd47029a01efbc1bc0a6b6c7dfc41166", "sha256": "3d45085a47e2b0adf7368c051a048b376aa9a91e5a2b14250888ffe83413cfc1" }, "downloads": -1, "filename": "python_deployment-0.0.1-cp27-cp27mu-manylinux1_x86_64.whl", "has_sig": false, "md5_digest": "bd47029a01efbc1bc0a6b6c7dfc41166", "packagetype": "bdist_wheel", "python_version": "cp27", "requires_python": null, "size": 395918, "upload_time": "2019-05-29T12:49:50", "url": "https://files.pythonhosted.org/packages/f2/2d/3e77b09a077e7d0d5e2e215a55416ebb5362f25510ab3e6300c1bb32ec1b/python_deployment-0.0.1-cp27-cp27mu-manylinux1_x86_64.whl" }, { "comment_text": "", "digests": { "md5": "4083ecb9434b61e484dd42309b607668", "sha256": "6dfdfe9979689c731795e160823c115cfae3582f5813646d892569dc98d0a839" }, "downloads": -1, "filename": "python_deployment-0.0.1-cp36-cp36m-manylinux1_i686.whl", "has_sig": false, "md5_digest": "4083ecb9434b61e484dd42309b607668", "packagetype": "bdist_wheel", "python_version": "cp36", "requires_python": null, "size": 377840, "upload_time": "2019-05-29T12:48:54", "url": "https://files.pythonhosted.org/packages/1b/08/f9812e71eac228c6fe5f2afef8f1e071351811805476d8935d4dadfc0e4b/python_deployment-0.0.1-cp36-cp36m-manylinux1_i686.whl" }, { "comment_text": "", "digests": { "md5": "e5d4af3d910cbb1f97a3ecafe1832e53", "sha256": "0430d690528eb474359fba19a52f2c4b5c6ff3a529bb836b79fb28ce21928d47" }, "downloads": -1, "filename": "python_deployment-0.0.1-cp36-cp36m-manylinux1_x86_64.whl", "has_sig": false, "md5_digest": "e5d4af3d910cbb1f97a3ecafe1832e53", "packagetype": "bdist_wheel", "python_version": "cp36", "requires_python": null, "size": 397916, "upload_time": "2019-05-29T12:48:57", "url": "https://files.pythonhosted.org/packages/24/44/92b412fd34beea3a363a9fad525d298dd4a1211397d07ecf2d75a9fe5ea1/python_deployment-0.0.1-cp36-cp36m-manylinux1_x86_64.whl" }, { "comment_text": "", "digests": { "md5": "098ad0c03a1b754136347f062725aee5", "sha256": "e696ef79a10675bd2be823650e7c48b1031fbc42685061806fdad751dcc5e45f" }, "downloads": -1, "filename": "python-deployment-0.0.1.tar.gz", "has_sig": false, "md5_digest": "098ad0c03a1b754136347f062725aee5", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 118851, "upload_time": "2019-05-29T13:23:40", "url": "https://files.pythonhosted.org/packages/fa/79/5c17dab5671d0a7bd4e389b5927080437eca089f693ee3612e1feecf54e6/python-deployment-0.0.1.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "74cf1b02b707f4d7be4a567031050b34", "sha256": "95f41f6550ec4f9f8b10d3cdd69e279bf0fbad52e3bdb572b46240e4d4c5fac9" }, "downloads": -1, "filename": "python_deployment-0.0.1-cp27-cp27m-manylinux1_i686.whl", "has_sig": false, "md5_digest": "74cf1b02b707f4d7be4a567031050b34", "packagetype": "bdist_wheel", "python_version": "cp27", "requires_python": null, "size": 378368, "upload_time": "2019-05-29T12:49:44", "url": "https://files.pythonhosted.org/packages/aa/59/d51c680c5ca2b8f66ad28ee2476dc8918b0a7df804b67eb4a4231ad1d141/python_deployment-0.0.1-cp27-cp27m-manylinux1_i686.whl" }, { "comment_text": "", "digests": { "md5": "5d0683c7e8a9c93fbf176669e368ae7b", "sha256": "4272985f7682022707c48308a3e42fd8fd84876484e29ee66b24a72b6044bed2" }, "downloads": -1, "filename": "python_deployment-0.0.1-cp27-cp27m-manylinux1_x86_64.whl", "has_sig": false, "md5_digest": "5d0683c7e8a9c93fbf176669e368ae7b", "packagetype": "bdist_wheel", "python_version": "cp27", "requires_python": null, "size": 395971, "upload_time": "2019-05-29T12:49:46", "url": "https://files.pythonhosted.org/packages/ab/ea/f824e8c77da70e0d0d9af3e268045756c9351e4fa788bf51871270443ca1/python_deployment-0.0.1-cp27-cp27m-manylinux1_x86_64.whl" }, { "comment_text": "", "digests": { "md5": "32abc46b36288e89912b15d0f1ec8da9", "sha256": "016f3aeec0b337ea1da150ef8d61eb56974fdad2a26e9f53abb741e7c719e6c3" }, "downloads": -1, "filename": "python_deployment-0.0.1-cp27-cp27mu-manylinux1_i686.whl", "has_sig": false, "md5_digest": "32abc46b36288e89912b15d0f1ec8da9", "packagetype": "bdist_wheel", "python_version": "cp27", "requires_python": null, "size": 378426, "upload_time": "2019-05-29T12:49:48", "url": "https://files.pythonhosted.org/packages/91/27/deff1e05a8cf2dc41c7eaf7b394b3b7a42b4f75a0e1904a4b091a7c3ec05/python_deployment-0.0.1-cp27-cp27mu-manylinux1_i686.whl" }, { "comment_text": "", "digests": { "md5": "bd47029a01efbc1bc0a6b6c7dfc41166", "sha256": "3d45085a47e2b0adf7368c051a048b376aa9a91e5a2b14250888ffe83413cfc1" }, "downloads": -1, "filename": "python_deployment-0.0.1-cp27-cp27mu-manylinux1_x86_64.whl", "has_sig": false, "md5_digest": "bd47029a01efbc1bc0a6b6c7dfc41166", "packagetype": "bdist_wheel", "python_version": "cp27", "requires_python": null, "size": 395918, "upload_time": "2019-05-29T12:49:50", "url": "https://files.pythonhosted.org/packages/f2/2d/3e77b09a077e7d0d5e2e215a55416ebb5362f25510ab3e6300c1bb32ec1b/python_deployment-0.0.1-cp27-cp27mu-manylinux1_x86_64.whl" }, { "comment_text": "", "digests": { "md5": "4083ecb9434b61e484dd42309b607668", "sha256": "6dfdfe9979689c731795e160823c115cfae3582f5813646d892569dc98d0a839" }, "downloads": -1, "filename": "python_deployment-0.0.1-cp36-cp36m-manylinux1_i686.whl", "has_sig": false, "md5_digest": "4083ecb9434b61e484dd42309b607668", "packagetype": "bdist_wheel", "python_version": "cp36", "requires_python": null, "size": 377840, "upload_time": "2019-05-29T12:48:54", "url": "https://files.pythonhosted.org/packages/1b/08/f9812e71eac228c6fe5f2afef8f1e071351811805476d8935d4dadfc0e4b/python_deployment-0.0.1-cp36-cp36m-manylinux1_i686.whl" }, { "comment_text": "", "digests": { "md5": "e5d4af3d910cbb1f97a3ecafe1832e53", "sha256": "0430d690528eb474359fba19a52f2c4b5c6ff3a529bb836b79fb28ce21928d47" }, "downloads": -1, "filename": "python_deployment-0.0.1-cp36-cp36m-manylinux1_x86_64.whl", "has_sig": false, "md5_digest": "e5d4af3d910cbb1f97a3ecafe1832e53", "packagetype": "bdist_wheel", "python_version": "cp36", "requires_python": null, "size": 397916, "upload_time": "2019-05-29T12:48:57", "url": "https://files.pythonhosted.org/packages/24/44/92b412fd34beea3a363a9fad525d298dd4a1211397d07ecf2d75a9fe5ea1/python_deployment-0.0.1-cp36-cp36m-manylinux1_x86_64.whl" }, { "comment_text": "", "digests": { "md5": "098ad0c03a1b754136347f062725aee5", "sha256": "e696ef79a10675bd2be823650e7c48b1031fbc42685061806fdad751dcc5e45f" }, "downloads": -1, "filename": "python-deployment-0.0.1.tar.gz", "has_sig": false, "md5_digest": "098ad0c03a1b754136347f062725aee5", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 118851, "upload_time": "2019-05-29T13:23:40", "url": "https://files.pythonhosted.org/packages/fa/79/5c17dab5671d0a7bd4e389b5927080437eca089f693ee3612e1feecf54e6/python-deployment-0.0.1.tar.gz" } ] }