Adds support to create repository from a template #1395

isouza-daitan · 2020-02-13T01:01:18Z

This PR adds a new create_repo_from_template method to AuthenticatedUser and Organization that uses the new /generate endpoint of a repo. I followed the same pattern as the similar create_fork method;

I also added a new is_template attribute to the Repository class. This attribute will only be sent by Github when we use the feature's Accept header which I only added to the POST to create the new repo. Let me know if I should also add it to get_repo calls.

The documentation mentions a template_repository attribute but Github never sends it.

scripts/add_attribute.py

tests/AuthenticatedUser.py

tests/Organization.py

tests/Repository.py

s-t-e-v-e-n-k · 2020-02-13T01:06:35Z

github/Organization.py

+        ), private
+        post_parameters = {
+            "name": name,
+            "owner": self.login,


I wonder if we should use self._identity here.

neither Organization nor AuthenticatedUser have an _identity property

scripts/add_attribute.py

s-t-e-v-e-n-k · 2020-02-13T01:10:43Z

github/Organization.py

@@ -357,6 +357,47 @@ def create_fork(self, repo):
            self._requester, headers, data, completed=True
        )

+    def create_repo_from_template(


Perhaps we should abstract this out to a mix-in, since it's identical...

s-t-e-v-e-n-k · 2020-02-13T01:11:26Z

I love the direction, but I think we need to have a think about how we implement this before we land it.

sfdye · 2020-02-13T01:12:14Z

Codecov Report

Merging #1395 into master will increase coverage by 0.14%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##           master    #1395      +/-   ##
==========================================
+ Coverage   98.20%   98.35%   +0.14%     
==========================================
  Files         188      188              
  Lines       14071    14140      +69     
==========================================
+ Hits        13819    13907      +88     
+ Misses        252      233      -19

Impacted Files	Coverage Δ
tests/Framework.py	`96.00% <0.00%> (-0.02%)`	⬇️
tests/Logging_.py	`100.00% <0.00%> (ø)`	⬆️
tests/NamedUser.py	`100.00% <0.00%> (ø)`	⬆️
tests/GitRelease.py	`100.00% <0.00%> (ø)`	⬆️
tests/Repository.py	`100.00% <0.00%> (ø)`	⬆️
tests/Persistence.py	`100.00% <0.00%> (ø)`	⬆️
tests/RateLimiting.py	`100.00% <0.00%> (ø)`	⬆️
github/Repository.py	`97.29% <0.00%> (+0.74%)`	⬆️
tests/AllTests.py	`100.00% <0.00%> (+1.07%)`	⬆️
github/Rate.py	`100.00% <0.00%> (+4.16%)`	⬆️
... and 1 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update e5ce491...1aac6e9. Read the comment docs.

isouza-daitan · 2020-02-13T01:29:33Z

@s-t-e-v-e-n-k thanks for the review!

The create_fork and create_repo_from_template methods are different than the other methods in the class because they are Repository endpoints, instead of Organization or User endpoints. Maybe we should move them to Repository? I think it would be harder to use but would at least match the API endpoint.

We could even keep the Org and AuthUser methods which would call the Repo method and set the appropriate owner. Thoughts?

codecov-io · 2020-02-13T01:33:18Z

Codecov Report

Merging #1395 into master will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master    #1395   +/-   ##
=======================================
  Coverage   98.35%   98.35%           
=======================================
  Files         188      188           
  Lines       14140    14140           
=======================================
  Hits        13907    13907           
  Misses        233      233

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update b4f5991...d1c282e. Read the comment docs.

isouza-daitan · 2020-02-27T18:08:05Z

@s-t-e-v-e-n-k thoughts on my comment above?

s-t-e-v-e-n-k · 2020-03-08T03:31:48Z

@isouza-daitan Sorry for the late reply. From a correctness perspective Repository is probably the right place, but given our architecture it's hard to require a user grab a repository object just to create a different repo, potentially in a different namespace entirely.

I'm still against the code duplication -- how about one method on AuthenicatedUser that also takes owner as NotSet. If owner is NotSet, use self.login, otherwise assert it's an Organization (or an id). What do you think?

isouza-daitan · 2020-03-12T17:15:57Z

@s-t-e-v-e-n-k won't we have auth problems if we try to create a new repo in an org using an AuthenticatedUser instance?

I agree getting a Repository to create a new repo is not great.
How about a new RepositoryActions module that has:

@staticmethod
def create_repo_from_template(
            new_repo_owner,  # AuthenticatedUser or Organization
            new_repo_name,
            template_full_name,  # my-org/my-template-name
            description=github.GithubObject.NotSet,
            private=github.GithubObject.NotSet,
    ):

and we call RepositoryActions.create_repo_from_template from AuthenticatedUser and Organization

stale · 2020-05-12T00:58:54Z

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

codecov-commenter · 2020-05-19T05:51:35Z

Codecov Report

Merging #1395 into master will increase coverage by 0.00%.
The diff coverage is 100.00%.

@@           Coverage Diff           @@
##           master    #1395   +/-   ##
=======================================
  Coverage   98.67%   98.67%           
=======================================
  Files          48       48           
  Lines        2561     2562    +1     
=======================================
+ Hits         2527     2528    +1     
  Misses         34       34

Impacted Files	Coverage Δ
github/Consts.py	`100.00% <100.00%> (ø)`

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 7ec4f15...a95e448. Read the comment docs.

stale · 2020-07-18T06:04:32Z

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

sfdye · 2020-07-18T09:21:18Z

Could you fix the python 3.6 tests?
I still see travis check in the PR, can you rebase against master?

stale · 2020-09-20T04:00:31Z

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

…hub into create-from-template

isacssouza · 2020-09-29T23:34:42Z

@sfdye done, sorry for the delay.

rue-nsilverman · 2020-11-18T20:46:42Z

Its also worth adding that the include_all_branches parameter now exists on the create repo from template API. This would be hugely beneficial to add in to this function.

simkimsia · 2021-07-31T03:18:43Z

I kinda need this. Can solve the conflict? @isouza-daitan

stale · 2022-01-08T23:20:22Z

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

prein · 2022-08-05T09:17:24Z

Please reopen and consider merging #2090

isouza-daitan added 5 commits February 11, 2020 09:57

Add create_repo_from_template to Organization and AuthenticatedUser

3f54ace

Fix create_repo_from_template docstring url

deea076

Add is_template attribute to Repository

a91899b

Add tests for the new create_repo_from_template method

ed363bb

Fix name assertion

ec44a8b

isouza-daitan commented Feb 13, 2020

View reviewed changes

scripts/add_attribute.py Outdated Show resolved Hide resolved

fix flake8 violation

1aac6e9

s-t-e-v-e-n-k reviewed Feb 13, 2020

View reviewed changes

isouza-daitan added 2 commits February 12, 2020 22:32

refactor assertions

1e4e605

Revert scripts/add_attribute.py change

a29b3c4

isouza-daitan and others added 2 commits February 12, 2020 22:41

Restore file delete by mistake

b4f5991

Merge branch 'master' into create-from-template

d1c282e

Merge branch 'master' into create-from-template

30e7100

stale bot added the stale label May 12, 2020

stale bot closed this May 19, 2020

sfdye reopened this May 19, 2020

stale bot removed the stale label May 19, 2020

stale bot added the stale label Jul 18, 2020

stale bot removed the stale label Jul 18, 2020

stale bot added the stale label Sep 20, 2020

isouza-daitan added 2 commits September 29, 2020 20:11

Merge branch 'master' into create-from-template

2c384f3

Merge branch 'create-from-template' of github.com:isouza-daitan/PyGit…

0bfe56d

…hub into create-from-template

stale bot removed the stale label Sep 29, 2020

Fix formatting

a95e448

simkimsia mentioned this pull request Jul 31, 2021

Create from template #2012

Closed

This was referenced Oct 21, 2021

Create from template #2088

Closed

Create repo from template #2090

Merged

stale bot added the stale label Jan 8, 2022

stale bot closed this Apr 16, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Adds support to create repository from a template #1395

Adds support to create repository from a template #1395

isouza-daitan commented Feb 13, 2020

s-t-e-v-e-n-k Feb 13, 2020

isouza-daitan Feb 13, 2020

s-t-e-v-e-n-k Feb 13, 2020

s-t-e-v-e-n-k commented Feb 13, 2020

sfdye commented Feb 13, 2020

isouza-daitan commented Feb 13, 2020

codecov-io commented Feb 13, 2020 •

edited

isouza-daitan commented Feb 27, 2020

s-t-e-v-e-n-k commented Mar 8, 2020

isouza-daitan commented Mar 12, 2020

stale bot commented May 12, 2020

codecov-commenter commented May 19, 2020 •

edited

stale bot commented Jul 18, 2020

sfdye commented Jul 18, 2020

stale bot commented Sep 20, 2020

isacssouza commented Sep 29, 2020

rue-nsilverman commented Nov 18, 2020

simkimsia commented Jul 31, 2021

stale bot commented Jan 8, 2022

prein commented Aug 5, 2022

Adds support to create repository from a template #1395

Adds support to create repository from a template #1395

Conversation

isouza-daitan commented Feb 13, 2020

s-t-e-v-e-n-k Feb 13, 2020

Choose a reason for hiding this comment

isouza-daitan Feb 13, 2020

Choose a reason for hiding this comment

s-t-e-v-e-n-k Feb 13, 2020

Choose a reason for hiding this comment

s-t-e-v-e-n-k commented Feb 13, 2020

sfdye commented Feb 13, 2020

Codecov Report

isouza-daitan commented Feb 13, 2020

codecov-io commented Feb 13, 2020 • edited

Codecov Report

isouza-daitan commented Feb 27, 2020

s-t-e-v-e-n-k commented Mar 8, 2020

isouza-daitan commented Mar 12, 2020

stale bot commented May 12, 2020

codecov-commenter commented May 19, 2020 • edited

Codecov Report

stale bot commented Jul 18, 2020

sfdye commented Jul 18, 2020

stale bot commented Sep 20, 2020

isacssouza commented Sep 29, 2020

rue-nsilverman commented Nov 18, 2020

simkimsia commented Jul 31, 2021

stale bot commented Jan 8, 2022

prein commented Aug 5, 2022

codecov-io commented Feb 13, 2020 •

edited

codecov-commenter commented May 19, 2020 •

edited