Skip to content
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

Script for creating a project #4370

Merged

Conversation

@jaraco
Copy link
Contributor

@jaraco jaraco commented Jul 16, 2018

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 --help to 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.

@stsewd
Copy link
Member

@stsewd stsewd commented Jul 16, 2018

I wonder if this fits better in contrib/

@stsewd
Copy link
Member

@stsewd stsewd commented Jul 16, 2018

Thanks for sharing the script :)

@jaraco jaraco force-pushed the feature/2725-add-project-script branch from 6ad05b1 to ee7d932 Jul 16, 2018
@jaraco
Copy link
Contributor Author

@jaraco jaraco commented Jul 16, 2018

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.

@jaraco jaraco force-pushed the feature/2725-add-project-script branch from ee7d932 to 0006d60 Jul 16, 2018
@agjohnson
Copy link
Contributor

@agjohnson agjohnson commented Jul 20, 2018

contrib/ is a better place for something like this, but this could be implemented much easier as a management command. A script like this is not likely to get any core developer attention in contrib/ so will likely rot pretty quick unfortunately.

Do you think this would be easy to port to a management command?

@agjohnson agjohnson added this to the Development improvements milestone Jul 20, 2018
@jaraco
Copy link
Contributor Author

@jaraco jaraco commented Jul 20, 2018

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.

@ericholscher
Copy link
Member

@ericholscher ericholscher commented Oct 31, 2018

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.

@ericholscher ericholscher merged commit cb7f865 into readthedocs:master Oct 31, 2018
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

None yet

4 participants