https://github.com/thiswillbeyourgithub/browniecutter

Quick script to create new python project
https://github.com/thiswillbeyourgithub/browniecutter

Last synced: 7 months ago
JSON representation

Quick script to create new python project

• Host: GitHub
• URL: https://github.com/thiswillbeyourgithub/browniecutter
• Owner: thiswillbeyourgithub
• License: gpl-3.0
• Created: 2024-06-14T12:37:42.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-11-26T12:27:18.000Z (over 1 year ago)
• Last Synced: 2024-11-26T13:28:39.423Z (over 1 year ago)
• Language: Python
• Size: 61.5 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

          

# 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

This TODO list is maintained automatically by [MdXLogseqTODOSync](https://github.com/thiswillbeyourgithub/MdXLogseqTODOSync)

- 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