{ "info": { "author": "Christophe VG", "author_email": "", "bugtrack_url": null, "classifiers": [ "Development Status :: 4 - Beta", "Environment :: Console", "Intended Audience :: Developers", "Intended Audience :: System Administrators", "License :: OSI Approved :: MIT License", "Programming Language :: Python", "Programming Language :: Python :: 2.7", "Programming Language :: Python :: 3.7", "Topic :: Software Development" ], "description": "# PyPi Template\n\n> My take at a template repository that I can fork for every Python project I want to push to PyPi\n\n[![Latest Version on PyPI](https://img.shields.io/pypi/v/pypi-template.svg)](https://pypi.python.org/pypi/pypi-template/)\n[![Supported Implementations](https://img.shields.io/pypi/pyversions/pypi-template.svg)](https://pypi.python.org/pypi/pypi-template/)\n[![Build Status](https://secure.travis-ci.org/christophevg/pypi-template.svg?branch=master)](http://travis-ci.org/christophevg/pypi-template)\n[![Documentation Status](https://readthedocs.org/projects/pypi-template/badge/?version=latest)](https://pypi-template.readthedocs.io/en/latest/?badge=latest)\n[![Coverage Status](https://coveralls.io/repos/github/christophevg/pypi-template/badge.svg?branch=master)](https://coveralls.io/github/christophevg/pypi-template?branch=master)\n[![Built with PyPi Template](https://img.shields.io/badge/PyPi_Template-v0.0.5-blue.svg)](https://github.com/christophevg/pypi-template)\n\n## Howto, the executive summary\n\n1. fork it\n2. rename it\n3. edit it\n4. extend it\n5. use it\n\n## Getting Started\n\nForking and renaming are the two first steps when using this repository. They are both actions you perform at GitHub, but...\n\n### Fork without forking...\n\nYou don't have to go through the GitHub concept of forking and do everything from the command line...\n\n```bash\n$ git clone https://github.com/christophevg/pypi-template\n$ mv pypi-template your-new-project\n$ cd your-new-project\n$ git remote remove origin\n$ git remote add origin git@github.com:your-account/your-new-project.git\n$ git push -u master origin\n```\n\n### Use the Command Line\n\nThe repository also includes a small script that copies the files from a clone of the repository. If you install the module, the script gets registered in your PATH, and allows for\n\n```bash\n$ pip install pypi-template\n\n$ mkdir my-new-project\n$ cd my-new-project\n\n$ pypi-template\n\n$ ls -la\ntotal 40\ndrwxr-xr-x 11 xtof staff 352 Nov 11 21:34 .\ndrwxr-xr-x 46 xtof staff 1472 Nov 11 21:10 ..\ndrwxr-xr-x 3 xtof staff 96 Nov 11 21:35 .github\n-rw-r--r-- 1 xtof staff 144 Nov 11 21:31 .travis.yml\n-rw-r--r-- 1 xtof staff 1067 Nov 11 21:34 LICENSE.txt\n-rw-r--r-- 1 xtof staff 443 Nov 11 21:34 Makefile\ndrwxr-xr-x 6 xtof staff 192 Nov 11 21:35 docs\ndrwxr-xr-x 3 xtof staff 96 Nov 11 21:35 pypi_template\n-rw-r--r-- 1 xtof staff 1830 Nov 11 21:34 setup.py\ndrwxr-xr-x 3 xtof staff 96 Nov 11 21:35 tests\n-rw-r--r-- 1 xtof staff 167 Nov 11 21:34 tox.ini\n```\n\nThe script only copies files that don't exist yet, so it can also be used to upgrade to a new version of PyPi Template, and import new features based on added folders. For changes to existing files, a more elaborate copying function will be added later, probably ;-)\n\n## Things to edit\n\n1. module top-level folder\n\nThere is a placeholder top-level module folder. You'll probably want to rename that.\n\n```bash\n$ mv pypi_template your_new_project\n```\n\n2. LICENSE.txt\n\nChange the license to whatever you feel is (more) appropriate.\n\n3. .github/README.md\n\nReplace this information with information regarding your project.\n\n4. setup.py\n\nReplace the Python package configuration with one appropriate to your project.\n\n5. docs/\n\nThe `docs/` contains a copy of this README as a placeholder for additional documentation, that can be published to [ReadTheDocs](https://readthedocs.org). Edit `conf.py` to reflect your project's name and description.\n\n## Things to do\n\n### Testing\n\nA basic testing setup has been prepared. To run it locally, issue...\n\n```bash\n$ make test\n...\n___________________________________ summary ____________________________________\n py27: commands succeeded\n congratulations :)\n```\n\nHead over to [https://travis-ci.org](https://travis-ci.org) and register your project. A basic CI configuration is also provided.\n\nHead over to [https://coveralls.io](https://coveralls.io) and register your project to consult your code coverage reporting.\n\n### Generate/Publish Documentation\n\n```bash\n$ make docs\n```\n\nThis wil generate a HTML version of your `docs/` and open it in a browser.\n\nIf you want to publish your documentation (from the [docs/](docs/) folder) to e.g. [ReadTheDocs](https://readthedocs.org), import the repository over there also.\n\n### Publishing to PyPi\n\nHead over to [https://test.pypi.org](https://test.pypi.org) and register for an account. Next simply issue...\n\n```bash\n$ make publish-test\n```\n\nto publish your module to the test instance of PyPi.\n\nor\n\n```bash\n$ make publish\n```\n\nto publish your module to the main instance of [PyPi](https://pypi.org).\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/christophevg/pypi-template", "keywords": "pypi template", "license": "MIT", "maintainer": "", "maintainer_email": "", "name": "pypi-template", "package_url": "https://pypi.org/project/pypi-template/", "platform": "", "project_url": "https://pypi.org/project/pypi-template/", "project_urls": { "Homepage": "https://github.com/christophevg/pypi-template" }, "release_url": "https://pypi.org/project/pypi-template/0.0.6/", "requires_dist": null, "requires_python": "", "summary": "PyPi template repository.", "version": "0.0.6" }, "last_serial": 4920898, "releases": { "0.0.1": [ { "comment_text": "", "digests": { "md5": "80164eea27aa15f177aafbce11f3ed60", "sha256": "7413a7d3caaccdb5615cba2c5cf3305ea2f1b46cd74787f2bea2e3afee49ff69" }, "downloads": -1, "filename": "pypi_template-0.0.1-py2-none-any.whl", "has_sig": false, "md5_digest": "80164eea27aa15f177aafbce11f3ed60", "packagetype": "bdist_wheel", "python_version": "py2", "requires_python": null, "size": 4189, "upload_time": "2018-10-29T19:20:27", "url": "https://files.pythonhosted.org/packages/87/0b/37b996a652a5a31f3492427e9aec3af914f79bd585c6eb938af885e52849/pypi_template-0.0.1-py2-none-any.whl" }, { "comment_text": "", "digests": { "md5": "ff575e9f95dc8ff1d7692d5a15b87685", "sha256": "57685d2444110d694ad03fc38505d1797f8c73259c586d31d95df4e8b0d76bc1" }, "downloads": -1, "filename": "pypi-template-0.0.1.tar.gz", "has_sig": false, "md5_digest": "ff575e9f95dc8ff1d7692d5a15b87685", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 3554, "upload_time": "2018-10-29T19:20:28", "url": "https://files.pythonhosted.org/packages/bc/83/9d503f582f4ecd5e99be192828400f7ea586ffc8a1d0e111ebce991e3b75/pypi-template-0.0.1.tar.gz" } ], "0.0.2": [ { "comment_text": "", "digests": { "md5": "dc5becb64c5cdd3c9abec41d24998459", "sha256": "e49a1cc336a53580c1be8c582b7d64b90fbfd09dd6661e6bb5d199d68dbfc8e9" }, "downloads": -1, "filename": "pypi_template-0.0.2-py2-none-any.whl", "has_sig": false, "md5_digest": "dc5becb64c5cdd3c9abec41d24998459", "packagetype": "bdist_wheel", "python_version": "py2", "requires_python": null, "size": 4313, "upload_time": "2018-10-30T18:30:27", "url": "https://files.pythonhosted.org/packages/2d/ba/9fd0068c1bfaf1c7b813a59e29714a87e6399affde04b9e18d9a0cf0881f/pypi_template-0.0.2-py2-none-any.whl" }, { "comment_text": "", "digests": { "md5": "f27c7d34720f2c66cb9947f14dc09ec9", "sha256": "1a59fee02d9d1ff3489aca93ad53e6f6b5bb6986395ee5e6f6543f36a99f5bc7" }, "downloads": -1, "filename": "pypi-template-0.0.2.tar.gz", "has_sig": false, "md5_digest": "f27c7d34720f2c66cb9947f14dc09ec9", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 3721, "upload_time": "2018-10-30T18:30:29", "url": "https://files.pythonhosted.org/packages/dd/73/9825c684edc0e331f472866c487b46c6f3f35fed185dc50751146c199376/pypi-template-0.0.2.tar.gz" } ], "0.0.3": [ { "comment_text": "", "digests": { "md5": "e871ac5de55e1aae5dd5d39315805c97", "sha256": "a1570ba0c25c5216851edbc558b386d3e42abbf893f89d7c68312d6bbebfd16a" }, "downloads": -1, "filename": "pypi_template-0.0.3-py2-none-any.whl", "has_sig": false, "md5_digest": "e871ac5de55e1aae5dd5d39315805c97", "packagetype": "bdist_wheel", "python_version": "py2", "requires_python": null, "size": 4906, "upload_time": "2018-11-04T15:21:04", "url": "https://files.pythonhosted.org/packages/f0/a8/2b05db20d9e297409e833f08e1baed07b4d34c11064a48debee6a2506cb4/pypi_template-0.0.3-py2-none-any.whl" }, { "comment_text": "", "digests": { "md5": "a804d9de9d4a7265ae0d814ab5351654", "sha256": "d5c0563931a30db5773da98123075957b8b3ecb8ccc258b9b5196fd47e7d632b" }, "downloads": -1, "filename": "pypi-template-0.0.3.tar.gz", "has_sig": false, "md5_digest": "a804d9de9d4a7265ae0d814ab5351654", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4361, "upload_time": "2018-11-04T15:21:07", "url": "https://files.pythonhosted.org/packages/b8/b0/e06831b11514b9c465e238586db3ab744182d299097f9ac0ac10d68e86c2/pypi-template-0.0.3.tar.gz" } ], "0.0.4": [ { "comment_text": "", "digests": { "md5": "1dda7b84c43a718e15fba6c0dd6476bc", "sha256": "bdb85b2995f9868f29f1f8a412f147c5c3d6e083c76ac8b88a9ef2f9f5e9a528" }, "downloads": -1, "filename": "pypi_template-0.0.4-py2-none-any.whl", "has_sig": false, "md5_digest": "1dda7b84c43a718e15fba6c0dd6476bc", "packagetype": "bdist_wheel", "python_version": "py2", "requires_python": null, "size": 4910, "upload_time": "2018-11-04T15:27:47", "url": "https://files.pythonhosted.org/packages/39/f8/476a175c5754b666c087823cc49575ca6f1abd941ce9f40fec6fc4f8fb2c/pypi_template-0.0.4-py2-none-any.whl" }, { "comment_text": "", "digests": { "md5": "41e8f2e15512f2b563bba355bbab63a6", "sha256": "adab82c61eae04bdef335ef609db13b8adf55674c0a5ca5cac03a9a3377e9629" }, "downloads": -1, "filename": "pypi-template-0.0.4.tar.gz", "has_sig": false, "md5_digest": "41e8f2e15512f2b563bba355bbab63a6", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4367, "upload_time": "2018-11-04T15:27:51", "url": "https://files.pythonhosted.org/packages/8e/47/b418e942efce1cc3a291033b89d1a2d672e19a8b4fcd404735fbca6de518/pypi-template-0.0.4.tar.gz" } ], "0.0.5": [ { "comment_text": "", "digests": { "md5": "d8d3d6537e837c5bc1b9fef51493f5eb", "sha256": "627989028a1b7e7e8ec1dab151586557f22f807367917dfc677c046f9757d873" }, "downloads": -1, "filename": "pypi_template-0.0.5-py2-none-any.whl", "has_sig": false, "md5_digest": "d8d3d6537e837c5bc1b9fef51493f5eb", "packagetype": "bdist_wheel", "python_version": "py2", "requires_python": null, "size": 4637, "upload_time": "2018-11-11T20:44:46", "url": "https://files.pythonhosted.org/packages/80/97/82b15f372468d7a980362a0434a8f31ce969d1a972b7c437b322893119b8/pypi_template-0.0.5-py2-none-any.whl" }, { "comment_text": "", "digests": { "md5": "2bcdd875b26f031e541b904b4484217f", "sha256": "8f326f8255f53a8bb3b979c2335aa5b3ee0d04582e4ae7fa5245bdbadc288885" }, "downloads": -1, "filename": "pypi-template-0.0.5.tar.gz", "has_sig": false, "md5_digest": "2bcdd875b26f031e541b904b4484217f", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4136, "upload_time": "2018-11-11T20:44:51", "url": "https://files.pythonhosted.org/packages/93/e9/1acc04f2b2eb2fea17309aef775fae7ad3889808b9bea73905aee880cfcd/pypi-template-0.0.5.tar.gz" } ], "0.0.6": [ { "comment_text": "", "digests": { "md5": "7b8c12325608af6dd7e93a9c54a685d5", "sha256": "c7267ef4f494f46c2127ccb8aa0492bf071a62543a19e0963e365e75bddb0c79" }, "downloads": -1, "filename": "pypi_template-0.0.6-py2-none-any.whl", "has_sig": false, "md5_digest": "7b8c12325608af6dd7e93a9c54a685d5", "packagetype": "bdist_wheel", "python_version": "py2", "requires_python": null, "size": 5139, "upload_time": "2019-03-10T09:52:34", "url": "https://files.pythonhosted.org/packages/50/c6/38242ee70de69f38fd73e842d9873d4a7c1ef940295c174281513ca2c1e4/pypi_template-0.0.6-py2-none-any.whl" }, { "comment_text": "", "digests": { "md5": "09153d095090bd2e3efac4db72170bca", "sha256": "faee46000ead0cc3034133a620fcf89471955b9d01a667bdf0bde55697e72d0f" }, "downloads": -1, "filename": "pypi-template-0.0.6.tar.gz", "has_sig": false, "md5_digest": "09153d095090bd2e3efac4db72170bca", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4688, "upload_time": "2019-03-10T09:52:36", "url": "https://files.pythonhosted.org/packages/1d/37/544da2b95ae197271fdff2c326ced8eca5c249fa16f6db73fe5dd74ce9bf/pypi-template-0.0.6.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "7b8c12325608af6dd7e93a9c54a685d5", "sha256": "c7267ef4f494f46c2127ccb8aa0492bf071a62543a19e0963e365e75bddb0c79" }, "downloads": -1, "filename": "pypi_template-0.0.6-py2-none-any.whl", "has_sig": false, "md5_digest": "7b8c12325608af6dd7e93a9c54a685d5", "packagetype": "bdist_wheel", "python_version": "py2", "requires_python": null, "size": 5139, "upload_time": "2019-03-10T09:52:34", "url": "https://files.pythonhosted.org/packages/50/c6/38242ee70de69f38fd73e842d9873d4a7c1ef940295c174281513ca2c1e4/pypi_template-0.0.6-py2-none-any.whl" }, { "comment_text": "", "digests": { "md5": "09153d095090bd2e3efac4db72170bca", "sha256": "faee46000ead0cc3034133a620fcf89471955b9d01a667bdf0bde55697e72d0f" }, "downloads": -1, "filename": "pypi-template-0.0.6.tar.gz", "has_sig": false, "md5_digest": "09153d095090bd2e3efac4db72170bca", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4688, "upload_time": "2019-03-10T09:52:36", "url": "https://files.pythonhosted.org/packages/1d/37/544da2b95ae197271fdff2c326ced8eca5c249fa16f6db73fe5dd74ce9bf/pypi-template-0.0.6.tar.gz" } ] }