search

yuki-koyama / blender-cli-rendering

Blender Python scripts for rendering images directly from command-line interface
GNU General Public License v3.0
756 stars 108 forks source link

Consider renaming to blender_cli_rendering for easier import #30

Open DavidLSmyth opened 4 years ago

DavidLSmyth commented 4 years ago

At the moment to use this as a dependency in a project it's necessary to use importlib or some other workaround to import modules since python is not a fan of hypens in module names. Renaming may be a simple solution

yuki-koyama commented 4 years ago

Thank you very much for your suggestion! I was also thinking about a similar approach. But one concern here is that changing the name will also change the repository URL, which may not be desirable.

Another possible approach in my mind is to create a new fork project with a different name with a slightly different goal, in which the helper functions (currently under the utils directory) can be organized in a more module-like manner.

DavidLSmyth commented 4 years ago

I think you can actually avoid needing to change the repository URL, git should automatically redirect to the new URL (see here). You could also just add a line in the readme for existing users to update the remote url using git remote set-url origin new_url which is pretty straightforward. I'd also recommend updating your __init__.py file in utils as it breaks things when using this repo as a dependency. Perhaps you'd consider trying to re-factor so that this can be cleanly installed using pip? Like you say, if you organize in a more module-like manner it could be more useful. Thanks for the great repo by the way!