# BrownieCutter
* I just needed a quick script to lower the time cost of creating new FOSS tools. So just run this script, give the project name and class name and you'll get a proper template dir with some boiletplate code done for you.
* Yes BrownieCutter was created by itself.
* Inspired by [CookieCutter](https://cookiecutter.readthedocs.io/).
# Getting started
* As an uv tool: `uvx BrownieCutter@latest --help`
* From pypi: `uv pip install BrownieCutter` or `pip install BrownieCutter`
* From git: git clone then `pip install .`
* `BrownieCutter --help`
### Roadmap
<i>This TODO list is maintained automatically by [MdXLogseqTODOSync](https://github.com/thiswillbeyourgithub/MdXLogseqTODOSync)</i>
<!-- BEGIN_TODO -->
- refactor to store the full files as is in a subdir, then write a function that does the regex replacement, major code cleanup and readibility expected from this
- add a pre commit hook file with isort, black
- add lines necessary for using MdXLogseqTODOSync
- fix the issue you found when refactoring wdoc about __init__.py vs __main__.py use the code of human readable seed for that
- add arg "requirements_source" to automatically populate the setup.py with them
- store the file content as fulltext in a source dir instead of in a var
- add arg "add to root"
- which automatically overwrites (copy not move) placeholders with what's given, for example to give a LICENSE
- must support dirs too
- add arg "add to project dir"
- for example used to copy the utils dir directly at the right location
- add args to import code directly from a python file
- use ast to match the imports line at the top
- use ast to get the class code you want to use
- if there is a version number, automatically set it to this number
<!-- END_TODO -->
Raw data
{
"_id": null,
"home_page": "https://github.com/thiswillbeyourgithub/BrownieCutter",
"name": "BrownieCutter",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.11",
"maintainer_email": null,
"keywords": "cookiecutter, pypi, install, package, python, minimal, minimalist, tool",
"author": null,
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/fd/ff/1a78aa668de08fa2e644c81da5f506633833f66cc5863c9422ecdefd7664/browniecutter-0.1.20.tar.gz",
"platform": null,
"description": "\n# BrownieCutter\n* I just needed a quick script to lower the time cost of creating new FOSS tools. So just run this script, give the project name and class name and you'll get a proper template dir with some boiletplate code done for you.\n* Yes BrownieCutter was created by itself.\n* Inspired by [CookieCutter](https://cookiecutter.readthedocs.io/).\n\n# Getting started\n* As an uv tool: `uvx BrownieCutter@latest --help`\n* From pypi: `uv pip install BrownieCutter` or `pip install BrownieCutter`\n* From git: git clone then `pip install .`\n* `BrownieCutter --help`\n\n\n### Roadmap\n<i>This TODO list is maintained automatically by [MdXLogseqTODOSync](https://github.com/thiswillbeyourgithub/MdXLogseqTODOSync)</i>\n<!-- BEGIN_TODO -->\n- refactor to store the full files as is in a subdir, then write a function that does the regex replacement, major code cleanup and readibility expected from this\n- add a pre commit hook file with isort, black\n- add lines necessary for using MdXLogseqTODOSync\n- fix the issue you found when refactoring wdoc about __init__.py vs __main__.py use the code of human readable seed for that\n- add arg \"requirements_source\" to automatically populate the setup.py with them\n- store the file content as fulltext in a source dir instead of in a var\n- add arg \"add to root\"\n - which automatically overwrites (copy not move) placeholders with what's given, for example to give a LICENSE\n - must support dirs too\n- add arg \"add to project dir\"\n - for example used to copy the utils dir directly at the right location\n- add args to import code directly from a python file\n - use ast to match the imports line at the top\n - use ast to get the class code you want to use\n - if there is a version number, automatically set it to this number\n<!-- END_TODO -->\n\n",
"bugtrack_url": null,
"license": "GPLv3",
"summary": "Quick script to create new python project",
"version": "0.1.20",
"project_urls": {
"Homepage": "https://github.com/thiswillbeyourgithub/BrownieCutter"
},
"split_keywords": [
"cookiecutter",
" pypi",
" install",
" package",
" python",
" minimal",
" minimalist",
" tool"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "37eea4565d0657aa583b86e6edc464553ad6b6b87e2e3058f3c049ed4846369d",
"md5": "1efcce38b942625c41e0039a79aeb506",
"sha256": "07fb62926b6fe171f9510de526a91a06b04564143d29ea7d1b528b7ac8528be5"
},
"downloads": -1,
"filename": "BrownieCutter-0.1.20-py3-none-any.whl",
"has_sig": false,
"md5_digest": "1efcce38b942625c41e0039a79aeb506",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11",
"size": 18538,
"upload_time": "2025-01-10T20:12:35",
"upload_time_iso_8601": "2025-01-10T20:12:35.302287Z",
"url": "https://files.pythonhosted.org/packages/37/ee/a4565d0657aa583b86e6edc464553ad6b6b87e2e3058f3c049ed4846369d/BrownieCutter-0.1.20-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "fdff1a78aa668de08fa2e644c81da5f506633833f66cc5863c9422ecdefd7664",
"md5": "593df2a872b0115371b928bfa0adcb3c",
"sha256": "f6f709caa6de3401c42cf54bd1eefc4c6936c1c7c014aabfb36919d0dc929a7d"
},
"downloads": -1,
"filename": "browniecutter-0.1.20.tar.gz",
"has_sig": false,
"md5_digest": "593df2a872b0115371b928bfa0adcb3c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11",
"size": 18740,
"upload_time": "2025-01-10T20:12:40",
"upload_time_iso_8601": "2025-01-10T20:12:40.197408Z",
"url": "https://files.pythonhosted.org/packages/fd/ff/1a78aa668de08fa2e644c81da5f506633833f66cc5863c9422ecdefd7664/browniecutter-0.1.20.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-10 20:12:40",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "thiswillbeyourgithub",
"github_project": "BrownieCutter",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "browniecutter"
}
JSON
