<!--
MIT License
Copyright (c) 2023 Dishant B. (@dishb) <code.dishb@gmail.com>
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
-->
<div align = 'center'>
<img alt = 'banner image' src = './assets/banner.png' width = 300/>
</div>
# firestarter
A cross-platform CLI to help you jump right into developing projects with Python.
## Features:
- Create boilerplate files + code for a Python package
- Create boilerplate files + code for a blank project
- Configure a testing framework
- Configure a linter
- Initialize a `git` repository
- Reusable template files (written in a custom langauge!)
## Documentation:
To get more information on how to use `firestarter`, you can read the documentation in the [`./docs`](https://github.com/dishb/firestarter/tree/main/docs) directory.
## Installation:
`firestarter` requires Python 3.9 or higher.
You can install the package with `pip`.
| macOS/Linux | Windows |
| --- | --- |
| `pip3 install firestarter` | `pip install firestarter` |
## Usage:
You can use `firestarter` by running the command below.
| macOS/Linux | Windows |
| --- | --- |
| `python3 -m firestarter` | `python -m firestarter` |
You can also just call `firestarter` directly.
## Contributing:
To get started with contributing to `firestarter`, follow this guide.
It is recommended to read the [`./CONTRIBUTING.md`](https://github.com/dishb/firestarter/blob/main/CONTRIBUTING.md) file.
1. Clone the repository:
| OS Independent |
| --- |
| `git clone https://github.com/dishb/firestarter.git` |
Change to the directory:
| macOS/Linux | Windows |
| --- | --- |
| `cd ./firestarter/` | `cd .\firestarter\` |
2. Create a virtual environment (optional, but recommended):
| macOS/Linux | Windows |
| --- | --- |
| `python3 -m venv ./.venv/` | `python -m venv .\.venv\` |
| `source ./.venv/bin/activate` | `.\.venv\Scripts\activate.bat` |
3. Install the dependencies:
| macOS/Linux | Windows |
| --- | --- |
| `pip3 install -r requirements.txt` | `pip install -r requirements.txt` |
| `pip3 install -r dev-requirements.txt` | `pip install -r dev-requirements.txt` |
4. Install `firestarter` in edit mode:
| macOS/Linux | Windows |
| --- | --- |
| `pip3 install -e .` | `pip install -e .` |
## Code of Conduct
This project is goverened by the Contributor Covenant Code of Conduct.
We ask that you read the full Code of Conduct in the [`./CODE_OF_CONDUCT.md`](https://github.com/dishb/firestarter/blob/main/CODE_OF_CONDUCT.md) file.
## License:
This project is licensed under the `MIT License`. The full copyright can be found in the [`./LICENSE.md`](https://github.com/dishb/firestarter/blob/main/LICENSE.md) file.
## Attribution
`firestarter`'s logo is an edited version of the FontAwesome [fire icon](https://fontawesome.com/icons/fire?f=classic&s=solid).
Raw data
{
"_id": null,
"home_page": "https://github.com/dishb/firestarter",
"name": "firestarter",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": "",
"keywords": "firestarter,quickstartbuild tool,project quickstart,cli,tool,developers,developing,firestarter tool,project maker,boilerplate,base files,python,cross-platform,python3",
"author": "Dishant B. (@dishb)",
"author_email": "code.dishb@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/41/0b/9e7507f11d49aa8de0f1c9727d72e35da07ba89e2c63ec36718721371d50/firestarter-0.0.2.tar.gz",
"platform": null,
"description": "<!--\nMIT License\n\nCopyright (c) 2023 Dishant B. (@dishb) <code.dishb@gmail.com>\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n-->\n\n<div align = 'center'>\n <img alt = 'banner image' src = './assets/banner.png' width = 300/>\n</div>\n\n# firestarter\nA cross-platform CLI to help you jump right into developing projects with Python.\n\n## Features:\n- Create boilerplate files + code for a Python package\n- Create boilerplate files + code for a blank project\n- Configure a testing framework\n- Configure a linter\n- Initialize a `git` repository\n- Reusable template files (written in a custom langauge!)\n\n## Documentation:\nTo get more information on how to use `firestarter`, you can read the documentation in the [`./docs`](https://github.com/dishb/firestarter/tree/main/docs) directory.\n\n## Installation:\n`firestarter` requires Python 3.9 or higher.\n\nYou can install the package with `pip`.\n\n| macOS/Linux | Windows |\n| --- | --- |\n| `pip3 install firestarter` | `pip install firestarter` |\n\n## Usage:\nYou can use `firestarter` by running the command below.\n\n| macOS/Linux | Windows |\n| --- | --- |\n| `python3 -m firestarter` | `python -m firestarter` |\n\nYou can also just call `firestarter` directly.\n\n## Contributing:\nTo get started with contributing to `firestarter`, follow this guide.\nIt is recommended to read the [`./CONTRIBUTING.md`](https://github.com/dishb/firestarter/blob/main/CONTRIBUTING.md) file.\n\n1. Clone the repository:\n\n | OS Independent |\n | --- |\n | `git clone https://github.com/dishb/firestarter.git` |\n\n Change to the directory:\n\n | macOS/Linux | Windows |\n | --- | --- |\n | `cd ./firestarter/` | `cd .\\firestarter\\` |\n\n2. Create a virtual environment (optional, but recommended):\n\n | macOS/Linux | Windows |\n | --- | --- |\n | `python3 -m venv ./.venv/` | `python -m venv .\\.venv\\` |\n | `source ./.venv/bin/activate` | `.\\.venv\\Scripts\\activate.bat` |\n\n3. Install the dependencies:\n\n | macOS/Linux | Windows |\n | --- | --- |\n | `pip3 install -r requirements.txt` | `pip install -r requirements.txt` |\n | `pip3 install -r dev-requirements.txt` | `pip install -r dev-requirements.txt` |\n\n4. Install `firestarter` in edit mode:\n\n | macOS/Linux | Windows |\n | --- | --- |\n | `pip3 install -e .` | `pip install -e .` |\n\n## Code of Conduct\nThis project is goverened by the Contributor Covenant Code of Conduct.\nWe ask that you read the full Code of Conduct in the [`./CODE_OF_CONDUCT.md`](https://github.com/dishb/firestarter/blob/main/CODE_OF_CONDUCT.md) file.\n\n## License:\nThis project is licensed under the `MIT License`. The full copyright can be found in the [`./LICENSE.md`](https://github.com/dishb/firestarter/blob/main/LICENSE.md) file.\n\n## Attribution\n`firestarter`'s logo is an edited version of the FontAwesome [fire icon](https://fontawesome.com/icons/fire?f=classic&s=solid).\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A cross-platform CLI to help you jump right into developing projects with Python.",
"version": "0.0.2",
"project_urls": {
"Documentation": "https://github.com/dishb/firestarter/tree/main/docs",
"Homepage": "https://github.com/dishb/firestarter",
"Issue Tracker": "https://github.com/dishb/firestarter/issues",
"Source": "https://github.com/dishb/firestarter/"
},
"split_keywords": [
"firestarter",
"quickstartbuild tool",
"project quickstart",
"cli",
"tool",
"developers",
"developing",
"firestarter tool",
"project maker",
"boilerplate",
"base files",
"python",
"cross-platform",
"python3"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e761f0388aff41f8309625e1023c1a4d1634e79cf650b73ff6d82b5890910d8f",
"md5": "7672b53ac2d640333dc7ec697d08ee79",
"sha256": "786807f50bf7ee177b9684e8f3b7e4359207a4ad28fbd3a41d58beb8609cfc2e"
},
"downloads": -1,
"filename": "firestarter-0.0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "7672b53ac2d640333dc7ec697d08ee79",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 14484,
"upload_time": "2023-09-04T17:08:18",
"upload_time_iso_8601": "2023-09-04T17:08:18.704296Z",
"url": "https://files.pythonhosted.org/packages/e7/61/f0388aff41f8309625e1023c1a4d1634e79cf650b73ff6d82b5890910d8f/firestarter-0.0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "410b9e7507f11d49aa8de0f1c9727d72e35da07ba89e2c63ec36718721371d50",
"md5": "77ceb5a249c03821ad2ae7359d9fd581",
"sha256": "aeff34ce94ed2bcf8c7df5cdc0a8f428a5ecb1fe2196aacfab0c1b6d13886ba0"
},
"downloads": -1,
"filename": "firestarter-0.0.2.tar.gz",
"has_sig": false,
"md5_digest": "77ceb5a249c03821ad2ae7359d9fd581",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 8895,
"upload_time": "2023-09-04T17:08:20",
"upload_time_iso_8601": "2023-09-04T17:08:20.369256Z",
"url": "https://files.pythonhosted.org/packages/41/0b/9e7507f11d49aa8de0f1c9727d72e35da07ba89e2c63ec36718721371d50/firestarter-0.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-09-04 17:08:20",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "dishb",
"github_project": "firestarter",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "firestarter"
}
JSON
