-
Notifications
You must be signed in to change notification settings - Fork 311
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Remove python module support #63
Comments
Not sure it would be fair to say no ones using it - I've seen it used a lot in custom hooks. I think we still need to strive for consistency as it make developing a lot easier. Do you see this just in the scope of documentation and versioning - or any code structure changes you see happening? Maybe good to look at Hashicorp Vault and see how they manage a CLI and restful API in the same code base. Possibly could do a complete separation with sceptre-core and sceptre-cli? We also need to consider how this restricts future extension to the project e.g. what if someone wants to wrap sceptre with flask etc... What issues have we run into so far with this supporting both? |
In some customers we are seriously considering using the module. I would MUCH rather prefer you don't remove it without offering another alternative API first. |
Hm okay if we keep it we still need some way of fixing the versioning issue. Separating the CLI from the Python core would do that as @seanrankine mentioned. Sean how do Hashicorp do it? I guess we could have two repositories, I think we still need the freedom to be able to change the python internals. I imagine we'd go though |
@jamesroutley I agree with @emiliogarcia and think this would be a nice way to do it. |
Decided to look at having two repositories, sceptre and sceptre-core. Continued in #76 |
Sceptre officially supports use via the CLI and as a Python module. Use via the CLI is far more common (I'm not sure if anyone uses Sceptre as a Python module). We guarantee that both our CLI and public Python APIs won't change. Guaranteeing the Python API leads to two problems:
This would be a relatively superficial change. Our Python function and classes would still be public, and people could still use Sceptre as a module, but we wouldn't officially support it or guarantee its API.
Implementation
Remove references to use as a Python module from the documentation.
Pros
Cons
The text was updated successfully, but these errors were encountered: