# Fabricius
Fabricius - A Python 3.10 Project Template engine with superpowers!
> :warning: Fabricius is a work in progress! Please, play with it with a grain of salt; expect bugs, crashes, non-documented portion of the application & more unexpected behavior.
Documentation: <https://fabricius.readthedocs.io>
> :warning: Fabricius still does not comes with it's CLI tool! It is a work in progress!
## Goals:
1. Create a working project from a project template
2. Create a fully working CLI using Rich
3. Ability to clone repository and use their templates
4. Create a secure tool (Do not allow unsecure scripts)
5. Create a fully type hinted tool
## Why the name of "Fabricius"?
I am an immense fan of roman names, and I very often name my project after a meaningful roman name.
"Fabricius" (In French, "Artisan") is translated to "craftsman", which is what Fabricius, the tool we create, aims to. His goal is to help at its best to create your projects easily.
## Why not just use CookieCutter or Copier instead of creating your own tool?
See goals, but other than that,
It's a question I am expecting with fears, I tried to first use CookieCutter myself but I never liked it at all, it always broke with me and was painful to use. On top of that, it does not comes with crucial things I would personally require, such as basic type checking when gathering user's input.
As for Copier, while it seems like a much more grown-up tool and *actually* fitting my need, I honestly did not try it, I just lost interested towards it and wanted to challenge myself in creating a new tool for the Python ecosystem.
On top of all of these, during my work in 2022, I ended up using TypeScript and using AdonisJS's CLI tool, and its awesome [template generator](https://docs.adonisjs.com/guides/ace-commandline#templates-generator), and so it made me really interested into creating a project scaffolder but using code, not a directory structure, which was lacking for both tools.
I wanted to create a complete and customizable experience of project scaffolding, I wanted to allow users to be free of do whatever they've meant to do, it's how I came up with the idea of plugins.
To me, Fabricius is more than just a simple project scaffolder, it's a complete handy swiss knife for their users. :)
Raw data
{
"_id": null,
"home_page": "https://github.com/Predeactor/Fabricius",
"name": "fabricius",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.10,<4.0",
"maintainer_email": "",
"keywords": "cookiecutter,template,project,scaffold,pyscaffold",
"author": "Predeactor",
"author_email": "pro.julien.mauroy@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/6e/f9/27a5c4ef865408be8885f3d8cc4d472bfc1dff6e1177d683e133bf7e21a2/fabricius-0.2.0.tar.gz",
"platform": null,
"description": "# Fabricius\n\nFabricius - A Python 3.10 Project Template engine with superpowers!\n\n> :warning: Fabricius is a work in progress! Please, play with it with a grain of salt; expect bugs, crashes, non-documented portion of the application & more unexpected behavior.\n\nDocumentation: <https://fabricius.readthedocs.io>\n\n> :warning: Fabricius still does not comes with it's CLI tool! It is a work in progress!\n\n## Goals:\n\n1. Create a working project from a project template\n2. Create a fully working CLI using Rich\n3. Ability to clone repository and use their templates\n4. Create a secure tool (Do not allow unsecure scripts)\n5. Create a fully type hinted tool\n\n## Why the name of \"Fabricius\"?\n\nI am an immense fan of roman names, and I very often name my project after a meaningful roman name.\n\n\"Fabricius\" (In French, \"Artisan\") is translated to \"craftsman\", which is what Fabricius, the tool we create, aims to. His goal is to help at its best to create your projects easily.\n\n## Why not just use CookieCutter or Copier instead of creating your own tool?\n\nSee goals, but other than that,\n\nIt's a question I am expecting with fears, I tried to first use CookieCutter myself but I never liked it at all, it always broke with me and was painful to use. On top of that, it does not comes with crucial things I would personally require, such as basic type checking when gathering user's input.\nAs for Copier, while it seems like a much more grown-up tool and *actually* fitting my need, I honestly did not try it, I just lost interested towards it and wanted to challenge myself in creating a new tool for the Python ecosystem.\n\nOn top of all of these, during my work in 2022, I ended up using TypeScript and using AdonisJS's CLI tool, and its awesome [template generator](https://docs.adonisjs.com/guides/ace-commandline#templates-generator), and so it made me really interested into creating a project scaffolder but using code, not a directory structure, which was lacking for both tools.\n\nI wanted to create a complete and customizable experience of project scaffolding, I wanted to allow users to be free of do whatever they've meant to do, it's how I came up with the idea of plugins.\n\nTo me, Fabricius is more than just a simple project scaffolder, it's a complete handy swiss knife for their users. :)\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Fabricius: The supportive templating engine for Python!",
"version": "0.2.0",
"project_urls": {
"Documentation": "https://fabricius.readthedocs.org",
"Homepage": "https://github.com/Predeactor/Fabricius",
"Repository": "https://github.com/Predeactor/Fabricius"
},
"split_keywords": [
"cookiecutter",
"template",
"project",
"scaffold",
"pyscaffold"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "7db7c41f08555b942a7d378ff48d50554a8a956af3b28ed6f6951ea408d95bf3",
"md5": "26cadd9cc034ed341bc947e99abdb0de",
"sha256": "4a1b84bd4258c52d163614ad972f471f2d8d4305a62e3e92785514f2381874ef"
},
"downloads": -1,
"filename": "fabricius-0.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "26cadd9cc034ed341bc947e99abdb0de",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10,<4.0",
"size": 25056,
"upload_time": "2023-05-27T23:11:48",
"upload_time_iso_8601": "2023-05-27T23:11:48.172811Z",
"url": "https://files.pythonhosted.org/packages/7d/b7/c41f08555b942a7d378ff48d50554a8a956af3b28ed6f6951ea408d95bf3/fabricius-0.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "6ef927a5c4ef865408be8885f3d8cc4d472bfc1dff6e1177d683e133bf7e21a2",
"md5": "3a9cfe1972d758e7092c540abe4178ab",
"sha256": "8729bf0ba328d3cab0d2a90fa94690153e4e6f54cfb53fb934082add7df0404e"
},
"downloads": -1,
"filename": "fabricius-0.2.0.tar.gz",
"has_sig": false,
"md5_digest": "3a9cfe1972d758e7092c540abe4178ab",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10,<4.0",
"size": 16556,
"upload_time": "2023-05-27T23:11:49",
"upload_time_iso_8601": "2023-05-27T23:11:49.889545Z",
"url": "https://files.pythonhosted.org/packages/6e/f9/27a5c4ef865408be8885f3d8cc4d472bfc1dff6e1177d683e133bf7e21a2/fabricius-0.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-05-27 23:11:49",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Predeactor",
"github_project": "Fabricius",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "fabricius"
}
JSON
