Metadata-Version: 2.1
Name: rename_github_default_branch
Version: 0.0.2
Summary: A Python script for bulk renaming the default branch of your GitHub repositories using the API
Home-page: https://github.com/dfm/rename_github_default_branch
Author: Dan Foreman-Mackey
Author-email: foreman.mackey@gmail.com
License: MIT
Description: The default git/GitHub branch name [is oppressive terminology](https://tools.ietf.org/id/draft-knodel-terminology-00.html#rfc.section.1.1) ([more info](https://mail.gnome.org/archives/desktop-devel-list/2019-May/msg00066.html)).
        It is easy to change the branch name [for a single repository](https://www.hanselman.com/blog/EasilyRenameYourGitDefaultBranchFromMasterToMain.aspx) or [for new repositories](https://leigh.net.au/writing/git-init-main/).
        This script makes it easy to rename your default branch on GitHub repositories in bulk.
        
        ## Usage
        
        ### Installation
        
        To install, run
        
        ```bash
        python -m pip install rename-github-default-branch
        ```
        
        Then, create a [GitHub.com personal access token](https://github.com/settings/tokens) with the `repo` permission scope and set the environment variable:
        
        ```bash
        export RENAME_GITHUB_TOKEN=YOUR_PERSONAL_ACCESS_TOKEN
        ```
        
        ### Renaming branches on GitHub
        
        Then to rename the default branch to `main` for a specific repository (you must have write access):
        
        ```bash
        rename-github-default-branch -r dfm/rename-github-default-branch -t main
        ```
        
        Or for all the repos that you own (excluding forks):
        
        ```bash
        rename-github-default-branch -t main
        ```
        
        You can also provide regular expressions to match against the repository name. For example:
        
        ```bash
        rename-github-default-branch -t main -p dfm/* -p exoplanet-dev/*
        ```
        
        ### Updating local branches
        
        To update your local repository, you can run the following:
        
        ```bash
        git fetch origin main
        git checkout -b main origin/main
        git branch -D master
        ```
        
        where `main` is the name of the new default branch and `origin` is the name of the git remote.
        
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Software Development :: Quality Assurance
Requires-Python: >=3.6
Description-Content-Type: text/markdown
