{ "info": { "author": "Danny McDonald", "author_email": "mcddjx@gmail.com", "bugtrack_url": null, "classifiers": [], "description": "# sire\n\n> *sire* is a command that generates Python 3.7 project templates, with git, travis, mypy (etc.) support.\n\n> Version 1.0.4\n\n[![Build Status](https://travis-ci.org/interrogator/sire.svg?branch=master)](https://travis-ci.org/interrogator/sire)\n[![codecov.io](https://codecov.io/gh/interrogator/sire/branch/master/graph/badge.svg)](https://codecov.io/gh/interrogator/sire)\n[![readthedocs](https://readthedocs.org/projects/sire/badge/?version=latest)](https://sire.readthedocs.io/en/latest/)\n[![PyPI version](https://badge.fury.io/py/sire.svg)](https://badge.fury.io/py/sire)\n[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/python/black)\n\n## Install sire\n\n```bash\npip install sire\n#or\ngit clone https://github.com/interrogator/sire && cd sire && python.setup.py install\n```\n\n## Usage\n\n```bash\nsire --mkdocs --virtualenv --git --exclude=mypy \n```\n\n## Alternative usages (not recommended)\n\nAs Python module:\n\n```bash\npython -m sire.sire mkdocs virtualenv \n```\n\nOr from inside Python (why?):\n\n```python\nfrom sire import sire\nsire('project_name', mkdocs=True, virtualenv=True, git=True)\n```\n\n### What gets generated\n\nPure Python:\n\n* `/.py`\n* `/__init__.py`\n* `setup.py`\n* `requirements.txt` (with *black*, *isort*, *flake8* etc)\n* `tests/tests.py`\n\nOptional extras:\n\n* mkdocs (`.readthedocs.yaml`, `./docs`, `.mkdocs.yml`)\n* irtualenv (with dependencies installed)\n* git (`.git`, `.gitignore`, `.pre-commit-config.yaml`)\n\nEach of these has an associated flag:\n\n```bash\nsire -v/--virtualenv -m/--mkdocs -g/--git projname\n```\n\nOther files\n\n* `.coveragerc`\n* `.travis.yml`\n* `publish.sh` (a script for running tests and authoring a new version)\n* `mypy.ini`\n* MIT License\n* Empty `CHANGELOG`\n* `.bumpversion.cfg`\n\nIf you want to skip any of these files, use the `--exclude` option with comma separation:\n\n```bash\nsire --exclude=travis,setup.py,mypy projname\n```\n\n## Trivia\n\n* *sire* actually generated itself.\n\n## Contributing\n\nI don't really expect many other people to want this, because it's mostly tailored to my specific ideas about how a Pthon project should look. That said, if you do find this projet useful, you are more than welcome to submit pull/feature requests!\n\nThere are dozens of possible new features that could be added, which I'd personally quite like:\n\n* a `--license` option, to choose the correct license file\n* Setting git remote automatically (get github username from git global config?)\n* Deleting irrelevant strings --- if no *codecoverage*, remove the associated badge for example\n* Probably more code could be automatically generated and added for the main and test `.py` files\n\nWhile I'd love to have these in *sire*, coding them will take me longer than doing it manually a few times. So, unless this repo somehow becomes popular or finds some new contributors, don't expect any of this stuff to get done in a hurry, unless you add it yourself.", "description_content_type": "text/markdown", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "http://github.com/interrogator/sire", "keywords": "", "license": "MIT", "maintainer": "", "maintainer_email": "", "name": "sire", "package_url": "https://pypi.org/project/sire/", "platform": "", "project_url": "https://pypi.org/project/sire/", "project_urls": { "Homepage": "http://github.com/interrogator/sire" }, "release_url": "https://pypi.org/project/sire/1.0.4/", "requires_dist": null, "requires_python": "", "summary": "Python project generator", "version": "1.0.4" }, "last_serial": 5498115, "releases": { "0.0.4": [ { "comment_text": "", "digests": { "md5": "8066f65d85e57aa508c20b108c30fb4c", "sha256": "038e2f1c23bf06468cd20ac6df8554331d9db46e100cc042e53bc833b8c7c844" }, "downloads": -1, "filename": "sire-0.0.4-py3.7.egg", "has_sig": false, "md5_digest": "8066f65d85e57aa508c20b108c30fb4c", "packagetype": "bdist_egg", "python_version": "3.7", "requires_python": null, "size": 1669, "upload_time": "2019-07-05T15:48:13", "url": "https://files.pythonhosted.org/packages/8e/09/c2c0b019582934fdde0783e14089ac044f625170352958058724550da074/sire-0.0.4-py3.7.egg" }, { "comment_text": "", "digests": { "md5": "012f94a88183923451d2e1eff4943989", "sha256": "7608485ca8a51338fb4856266dbb8be60aff39cee0f373f208994a6a863942c2" }, "downloads": -1, "filename": "sire-0.0.4.tar.gz", "has_sig": false, "md5_digest": "012f94a88183923451d2e1eff4943989", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 1375, "upload_time": "2019-07-05T15:48:16", "url": "https://files.pythonhosted.org/packages/8f/c7/7b5f4eedc9a639aeaff6bf2ae57149d9903230664b5091b5e94e6d81c808/sire-0.0.4.tar.gz" } ], "0.0.5": [ { "comment_text": "", "digests": { "md5": "1b5f03b8fe3518bfa8232b4fb7d1736f", "sha256": "67ebb2a29dfac316d4ecf11330cbec57cf1ef2a46bd8ab50e24a784a3f23ead3" }, "downloads": -1, "filename": "sire-0.0.5-py3.7.egg", "has_sig": false, "md5_digest": "1b5f03b8fe3518bfa8232b4fb7d1736f", "packagetype": "bdist_egg", "python_version": "3.7", "requires_python": null, "size": 1670, "upload_time": "2019-07-05T15:51:02", "url": "https://files.pythonhosted.org/packages/0a/42/92a19155aecd4826a9e320d081e7f8d76a92d17701907f803dd89cc05376/sire-0.0.5-py3.7.egg" }, { "comment_text": "", "digests": { "md5": "1e2453b1fadab87765ee0a9eb32fc4a9", "sha256": "8ccd1aa6c9c5648fcdaa2c5849a5c000ca0fe0cc3bfeeb42cd046b92e2cdd012" }, "downloads": -1, "filename": "sire-0.0.5.tar.gz", "has_sig": false, "md5_digest": "1e2453b1fadab87765ee0a9eb32fc4a9", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 1379, "upload_time": "2019-07-05T15:51:04", "url": "https://files.pythonhosted.org/packages/89/07/262a656feea330b21b0a59479fe2818a408c24bdd8a60eb6a8d74e02a67c/sire-0.0.5.tar.gz" } ], "1.0.0": [ { "comment_text": "", "digests": { "md5": "64d34e3e8bb2cbb660c68d6cb7e7c743", "sha256": "49004bbfd038cb359bdd68eeacdfe9d5a41b23bf5bc70bce297ce6fffb0dcc95" }, "downloads": -1, "filename": "sire-1.0.0-py3.7.egg", "has_sig": false, "md5_digest": "64d34e3e8bb2cbb660c68d6cb7e7c743", "packagetype": "bdist_egg", "python_version": "3.7", "requires_python": null, "size": 11846, "upload_time": "2019-07-05T16:36:36", "url": "https://files.pythonhosted.org/packages/f3/f6/dde17cffda628d5cf141c21fdb6387c56e21f6c5ae1f8297b61e14bc2ffb/sire-1.0.0-py3.7.egg" }, { "comment_text": "", "digests": { "md5": "8a77b8a2030887b10e0539d1f33dfc16", "sha256": "4f29ecc3fa59bc9ceae7657c62663a081c235e10d1ada09571eec0c3f47ae108" }, "downloads": -1, "filename": "sire-1.0.0.tar.gz", "has_sig": false, "md5_digest": "8a77b8a2030887b10e0539d1f33dfc16", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 6759, "upload_time": "2019-07-05T16:36:37", "url": "https://files.pythonhosted.org/packages/91/a0/bab6096675b553cddf20361b3e63a8c2e4a7042ead5d375d928debf8e0b0/sire-1.0.0.tar.gz" } ], "1.0.1": [ { "comment_text": "", "digests": { "md5": "4d36c646716f2423823233da603acbbc", "sha256": "e7106c7fc230614edd4a57fd6cd1dadc676f789e52b6ab911e13be02a2f3f2b6" }, "downloads": -1, "filename": "sire-1.0.1-py3.7.egg", "has_sig": false, "md5_digest": "4d36c646716f2423823233da603acbbc", "packagetype": "bdist_egg", "python_version": "3.7", "requires_python": null, "size": 12196, "upload_time": "2019-07-05T17:02:50", "url": "https://files.pythonhosted.org/packages/8b/fc/0900edad9b2d6fe62084ac58e3e7711226e578faafd43c05987281cb013c/sire-1.0.1-py3.7.egg" }, { "comment_text": "", "digests": { "md5": "e18941ff4dc4bfe0cbe67a0483cc44fd", "sha256": "dd61c5e9db21f8e546f20739922d2e18309307a674f6f1dd5dd74c359fb5ef83" }, "downloads": -1, "filename": "sire-1.0.1.tar.gz", "has_sig": false, "md5_digest": "e18941ff4dc4bfe0cbe67a0483cc44fd", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 7085, "upload_time": "2019-07-05T17:02:52", "url": "https://files.pythonhosted.org/packages/77/90/67c3a291ee8db6544870244039f558df44d921d55621e22887c14dd1c257/sire-1.0.1.tar.gz" } ], "1.0.2": [ { "comment_text": "", "digests": { "md5": "becaa35c576ef737a8ceb544078aa786", "sha256": "c0e4ca790134f93e16e93402e0942452d63b23710d77a2a0ae718daa9e6814b0" }, "downloads": -1, "filename": "sire-1.0.2-py3.7.egg", "has_sig": false, "md5_digest": "becaa35c576ef737a8ceb544078aa786", "packagetype": "bdist_egg", "python_version": "3.7", "requires_python": null, "size": 12198, "upload_time": "2019-07-05T17:08:57", "url": "https://files.pythonhosted.org/packages/fc/02/c3420e4169c02a214cde092624561edff21e729d6b4bb36a21eee0a397ab/sire-1.0.2-py3.7.egg" }, { "comment_text": "", "digests": { "md5": "771e58ffb079c9df1d3b53b2a68b42f9", "sha256": "7253bdcd40718c5bd23b0e1260d0dae8ab29fec39cc4b336e13ee49b65added6" }, "downloads": -1, "filename": "sire-1.0.2.tar.gz", "has_sig": false, "md5_digest": "771e58ffb079c9df1d3b53b2a68b42f9", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 7089, "upload_time": "2019-07-05T17:08:59", "url": "https://files.pythonhosted.org/packages/de/37/362962eeb34ed1200435849c76ce503b703654811d1361487b1887bf0e58/sire-1.0.2.tar.gz" } ], "1.0.3": [ { "comment_text": "", "digests": { "md5": "57cbbdcf446d0798c9add14f9bbb33da", "sha256": "0383ebd1954b94c7f58c986dd7e7eac0ce4a8f2c45a442d39c2ea9e68b7c8613" }, "downloads": -1, "filename": "sire-1.0.3-py3.6.egg", "has_sig": false, "md5_digest": "57cbbdcf446d0798c9add14f9bbb33da", "packagetype": "bdist_egg", "python_version": "3.6", "requires_python": null, "size": 19058, "upload_time": "2019-07-07T20:59:06", "url": "https://files.pythonhosted.org/packages/57/d6/198e46c2387b2f07550a8ec2be56420703aecab83c2ccd83dea49bd5ed9f/sire-1.0.3-py3.6.egg" }, { "comment_text": "", "digests": { "md5": "bc9c5a4f1663e35deeabbcdb8d8c3e4f", "sha256": "2988e655daf93db5c28f25a1d8ab01afc364bf6e84b8aec413d9f4f893f71ecd" }, "downloads": -1, "filename": "sire-1.0.3.tar.gz", "has_sig": false, "md5_digest": "bc9c5a4f1663e35deeabbcdb8d8c3e4f", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 11343, "upload_time": "2019-07-07T20:59:08", "url": "https://files.pythonhosted.org/packages/47/2b/32849183e9b40ad39257efa2030889ca4c0da01b650a60e60793958c8485/sire-1.0.3.tar.gz" } ], "1.0.4": [ { "comment_text": "", "digests": { "md5": "0efa4731802683b49223f53ea05b5845", "sha256": "971e27966dd6fa19affb9a8e85c5d7f9e248fffa5bc2edf47d335c793fdd1b78" }, "downloads": -1, "filename": "sire-1.0.4-py3.6.egg", "has_sig": false, "md5_digest": "0efa4731802683b49223f53ea05b5845", "packagetype": "bdist_egg", "python_version": "3.6", "requires_python": null, "size": 19373, "upload_time": "2019-07-07T21:28:23", "url": "https://files.pythonhosted.org/packages/d1/10/86371063cca65450ed33da09d16955aa881f6294b3bd4ef7ef7966e07449/sire-1.0.4-py3.6.egg" }, { "comment_text": "", "digests": { "md5": "e2d67e31e0a47f6946243b57be4688c7", "sha256": "0d325b0b367dc4d1b251a42c478a66b7b23cf5ceb03c7bf983700eb334b4419e" }, "downloads": -1, "filename": "sire-1.0.4.tar.gz", "has_sig": false, "md5_digest": "e2d67e31e0a47f6946243b57be4688c7", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 11527, "upload_time": "2019-07-07T21:28:25", "url": "https://files.pythonhosted.org/packages/9d/34/22b7e37173c471b7cc36de87144e2c11a395b73b2dc90a6b99ddd741ea82/sire-1.0.4.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "0efa4731802683b49223f53ea05b5845", "sha256": "971e27966dd6fa19affb9a8e85c5d7f9e248fffa5bc2edf47d335c793fdd1b78" }, "downloads": -1, "filename": "sire-1.0.4-py3.6.egg", "has_sig": false, "md5_digest": "0efa4731802683b49223f53ea05b5845", "packagetype": "bdist_egg", "python_version": "3.6", "requires_python": null, "size": 19373, "upload_time": "2019-07-07T21:28:23", "url": "https://files.pythonhosted.org/packages/d1/10/86371063cca65450ed33da09d16955aa881f6294b3bd4ef7ef7966e07449/sire-1.0.4-py3.6.egg" }, { "comment_text": "", "digests": { "md5": "e2d67e31e0a47f6946243b57be4688c7", "sha256": "0d325b0b367dc4d1b251a42c478a66b7b23cf5ceb03c7bf983700eb334b4419e" }, "downloads": -1, "filename": "sire-1.0.4.tar.gz", "has_sig": false, "md5_digest": "e2d67e31e0a47f6946243b57be4688c7", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 11527, "upload_time": "2019-07-07T21:28:25", "url": "https://files.pythonhosted.org/packages/9d/34/22b7e37173c471b7cc36de87144e2c11a395b73b2dc90a6b99ddd741ea82/sire-1.0.4.tar.gz" } ] }