Script for creating a project#4370
Conversation
|
I wonder if this fits better in |
|
Thanks for sharing the script :) |
|
Agreed. Contrib is better. I was working from an old commit which had neither contrib nor scripts, but given that the latest master has both, I prefer contrib also. |
|
Do you think this would be easy to port to a management command? |
|
Okay, except this isn't about managing rtd... so it shouldn't come with the burden of setting up an RTD environment. It's a client command (so it barely belongs in this repo at all, except that I can't think of a better place for it). It's the kind of thing that would ideally be exposed in the API, so this script fills the gap until the API perform the function. Any API implementation would probably not use these techniques, so it's fine that it will bit rot. As it is, though, it requires Python 3.6 and later and is only 168 lines long, so there's not much to rot. For me, I'm happy to use the script from the jaraco fork. It serves the purpose where it is, providing a concrete, working implementation of a mechanized process to create a new project from Github in close to as concise an implementation as is currently known to be possible. You can take it or leave it. |
|
Merging this because it's useful 💯. I think adding a guide or docs around this would make it more discoverable, but we should at least include it for now. |
To address #2725, in this commit, I've put together a script that creates a RTD project based on a GitHub repo checkout. It makes some assumptions, but attempts to provide flexibility for any user to use.
It currently requires Python 3.6+ and several 3rd party libraries (declared in the script). It can be invoked with
rwt -- scripts/add-project.py(pass--helpto test invocation without execution).I'm hoping this script can be included for publication, reference, and possible iterative improvement.
Please let me know if there's anything more you would like to see to include this work in the project.