├── better_git_cli
├── __init__.py
├── helpers.py
├── main.py
├── languages.py
├── options.py
├── new_repo.py
├── user.py
├── sshkeys.py
└── repos.py
├── requirements.txt
├── .pre-commit-config.yaml
├── .github
└── workflows
│ ├── release-please.yml
│ └── codeql-analysis.yml
├── .travis.yml
├── pyproject.toml
├── CHANGELOG.md
├── .gitignore
├── README.md
└── LICENSE
/better_git_cli/__init__.py:
--------------------------------------------------------------------------------
1 |
--------------------------------------------------------------------------------
/requirements.txt:
--------------------------------------------------------------------------------
1 | colorama==0.4.4
2 | PyGithub==1.54.1
3 | PyInquirer==1.0.3
--------------------------------------------------------------------------------
/.pre-commit-config.yaml:
--------------------------------------------------------------------------------
1 | repos:
2 | - repo: https://github.com/pre-commit/pre-commit-hooks
3 | rev: v2.3.0
4 | hooks:
5 | - id: check-yaml
6 | - id: end-of-file-fixer
7 | - id: trailing-whitespace
8 | - repo: https://github.com/psf/black
9 | rev: 20.8b1
10 | hooks:
11 | - id: black
12 |
--------------------------------------------------------------------------------
/.github/workflows/release-please.yml:
--------------------------------------------------------------------------------
1 | on:
2 | push:
3 | branches:
4 | - master
5 | name: release-please
6 | jobs:
7 | release-please:
8 | runs-on: ubuntu-latest
9 | steps:
10 | - uses: GoogleCloudPlatform/release-please-action@v2
11 | with:
12 | release-type: python
13 | package-name: bettergitcli
14 | version-file: ./pyproject.toml
15 |
--------------------------------------------------------------------------------
/.travis.yml:
--------------------------------------------------------------------------------
1 | language: python
2 | dist: xenial
3 | before_install:
4 | - curl -sSL https://raw.githubusercontent.com/sdispater/poetry/master/get-poetry.py | python
5 | - source $HOME/.poetry/env
6 | install:
7 | - poetry install
8 | script:
9 | - poetry build
10 | deploy:
11 | - provider: script
12 | skip_cleanup: true
13 | script: poetry publish --username $PYPI_USER_NAME --password $PYPI_TOKEN
14 | on:
15 | branch: master
16 | python: '3.6'
17 | tags: true
--------------------------------------------------------------------------------
/better_git_cli/helpers.py:
--------------------------------------------------------------------------------
1 | """
2 | Various helper functions used through out the application
3 | """
4 |
5 | from github import Github
6 | from colorama import Fore
7 | import os
8 |
9 |
10 | # Prints a green success message
11 | def error(contents):
12 | print(Fore.RED + contents + Fore.RESET)
13 |
14 |
15 | # Prints a red error message
16 | def success(contents):
17 | print(Fore.GREEN + contents + Fore.RESET)
18 |
19 |
20 | # Initialise and return a GitHub client instance
21 | def github():
22 | return Github(os.getenv("GITHUB_AUTH_TOKEN"))
23 |
--------------------------------------------------------------------------------
/better_git_cli/main.py:
--------------------------------------------------------------------------------
1 | import os
2 | from sys import exit
3 |
4 | from better_git_cli.options import start_menu
5 | from better_git_cli.helpers import github
6 | from colorama import init, Fore
7 |
8 |
9 | def cli_main():
10 | g = github()
11 | if "GITHUB_AUTH_TOKEN" in os.environ:
12 | print(f"Welcome to BetterGitCLI, {g.get_user().name}!")
13 | else:
14 | exit(
15 | Fore.RED
16 | + 'ERROR: Could not find your GitHub token. \nPlease export it first in your shell as "GITHUB_AUTH_TOKEN".'
17 | + Fore.RESET
18 | )
19 |
20 | start_menu()
21 |
22 |
23 | if __name__ == "__main__":
24 | # Init colorama (needed for Windows)
25 | init()
26 | cli_main()
27 |
--------------------------------------------------------------------------------
/pyproject.toml:
--------------------------------------------------------------------------------
1 | [tool.poetry]
2 | name = "BetterGitCLI"
3 | version = "1.3.0"
4 | description = "GitHub CLI with intuitive UI and keyboard controls!"
5 | authors = ["Piotr Rutkowski"]
6 | license = "GPL-3.0-only"
7 | repository = "https://github.com/PiotrRut/BetterGitCLI"
8 | homepage = "https://github.com/PiotrRut/BetterGitCLI"
9 | readme = "README.md"
10 |
11 |
12 | packages = [
13 | { include = "better_git_cli" },
14 | { include = "better_git_cli/*.py" },
15 | ]
16 |
17 | [tool.poetry.dependencies]
18 | python = "^3.6"
19 | PyGithub = "*"
20 | colorama = "*"
21 | PyInquirer = "*"
22 |
23 | [build-system]
24 | requires = ["poetry-core>=1.0.0"]
25 | build-backend = "poetry.core.masonry.api"
26 |
27 | [tool.poetry.scripts]
28 | bettergitcli = 'better_git_cli.main:cli_main'
29 |
--------------------------------------------------------------------------------
/CHANGELOG.md:
--------------------------------------------------------------------------------
1 | # Changelog
2 |
3 | ## [1.3.0](https://www.github.com/PiotrRut/BetterGitCLI/compare/v1.2.0...v1.3.0) (2021-03-06)
4 |
5 |
6 | ### Features
7 |
8 | * New feature: Create SSH keys :sparkles: ([9193844](https://www.github.com/PiotrRut/BetterGitCLI/commit/9193844ae2c76995781c4f5aeb7a540fc4522c3c))
9 |
10 | ## 1.2.0 (03/21)
11 |
12 | ### Features
13 | - New feature: Create a new repository 🎉
14 |
15 | ## 1.1.0 (02/21)
16 | ### Features
17 | - New feature: language statistics 🎉
18 | - Lets you see your top languages, and a total count of each language used on your account
19 | - Refactored a lot of code to make it simpler and clearer
20 | - Integrated [black](https://github.com/psf/black) code formatting
21 |
22 | ### Bug Fixes
23 | - Fixed a bug where you were not able to return to main menu or exit to shell from inside *SSH keys management* 🐛
24 |
25 | ## 1.0.2 (02/21)
26 | ### Features
27 | - Updated docs
28 |
29 | ### Bug Fixes
30 | - Fixed a major bug where the application would crash on launch 🐛
31 |
32 | ## 1.0 (02/21)
33 | ### Features
34 | - Initial release of BetterGitCLI 🎉
35 |
--------------------------------------------------------------------------------
/better_git_cli/languages.py:
--------------------------------------------------------------------------------
1 | """
2 | Language stats
3 | """
4 |
5 | from PyInquirer import prompt
6 | from better_git_cli.helpers import *
7 | import better_git_cli.options as options
8 |
9 |
10 | def language_stats():
11 |
12 | git_user = github().get_user()
13 |
14 | list_options = [
15 | {
16 | "type": "list",
17 | "name": "language_stats",
18 | "message": "",
19 | "choices": [
20 | {"name": "Return to main menu", "value": 1},
21 | {"name": "Exit to shell", "value": 2},
22 | ],
23 | }
24 | ]
25 |
26 | if git_user.get_repos().totalCount:
27 | repos_set = set()
28 | repos_list = []
29 | for repo in git_user.get_repos():
30 | if repo.language:
31 | repos_list.append(repo.language)
32 | repos_set.add(repo.language)
33 |
34 | print("-- YOUR LANGUAGE STATS --")
35 | for language in repos_set:
36 | print(f"{language}: {repos_list.count(language)} repo(s)")
37 | else:
38 | print("Your account does not have any repositories")
39 |
40 | answers = prompt(list_options)
41 |
42 | if answers.get("language_stats") == 1:
43 | options.start_menu()
44 |
45 | elif answers.get("language_stats") == 2:
46 | exit("Exiting now - see you later! 👋🏼")
47 |
48 | language_stats()
49 |
--------------------------------------------------------------------------------
/better_git_cli/options.py:
--------------------------------------------------------------------------------
1 | """
2 | Main menu of the app with all the available options
3 | """
4 |
5 | from PyInquirer import prompt, Separator
6 | from sys import exit
7 | from better_git_cli.repos import see_repos
8 | from better_git_cli.user import change_user_details
9 | from better_git_cli.sshkeys import manage_ssh_keys
10 | from better_git_cli.languages import language_stats
11 | from better_git_cli.new_repo import new_repo
12 |
13 |
14 | # Main menu of the application
15 | def start_menu():
16 |
17 | question = {
18 | "type": "list",
19 | "name": "main_menu",
20 | "message": "What would you like to do?",
21 | "choices": [
22 | {"name": "Manage existing repositories", "value": 1},
23 | {"name": "Create a new (remote) repository", "value": 2},
24 | {"name": "Manage my personal details", "value": 3},
25 | {"name": "Manage my SSH keys", "value": 4},
26 | {"name": "Show my language stats", "value": 5},
27 | Separator(),
28 | {"name": "Exit to shell", "value": 6},
29 | ],
30 | }
31 |
32 | answers = prompt(question)
33 |
34 | if answers.get("main_menu") == 1:
35 | see_repos()
36 |
37 | if answers.get("main_menu") == 2:
38 | new_repo()
39 |
40 | if answers.get("main_menu") == 3:
41 | change_user_details()
42 |
43 | if answers.get("main_menu") == 4:
44 | manage_ssh_keys()
45 |
46 | if answers.get("main_menu") == 5:
47 | language_stats()
48 |
49 | if answers.get("main_menu") == 6:
50 | exit("Exiting now - see you later! 👋🏼")
51 |
--------------------------------------------------------------------------------
/better_git_cli/new_repo.py:
--------------------------------------------------------------------------------
1 | """
2 | Create a new repository
3 | """
4 |
5 | from PyInquirer import prompt
6 | from better_git_cli.helpers import *
7 | import better_git_cli.options as options
8 | import webbrowser
9 | from github import GithubException
10 | from prompt_toolkit.validation import Validator, ValidationError
11 | import regex
12 |
13 |
14 | class RepoNameValidate(Validator):
15 | def validate(self, document):
16 | ok = regex.match("^[A-Za-z0-9_.-]*$", document.text)
17 | if not ok:
18 | raise ValidationError(
19 | message="Name can not contain spaces",
20 | cursor_position=len(document.text),
21 | ) # Move cursor to end
22 |
23 |
24 | def new_repo():
25 | git_user = github().get_user()
26 |
27 | are_you_sure = {
28 | "type": "confirm",
29 | "name": "are_you_sure",
30 | "message": "Are you sure you want to create a new repository?",
31 | "default": False,
32 | }
33 |
34 | questions = [
35 | {
36 | "type": "input",
37 | "name": "repo_name",
38 | "message": "Please provide a name:",
39 | "validate": RepoNameValidate,
40 | },
41 | {
42 | "type": "input",
43 | "name": "repo_desc",
44 | "message": "Please provide a description (ENTER to leave blank):",
45 | },
46 | {
47 | "type": "confirm",
48 | "name": "repo_private",
49 | "message": "Do you want this repository to be private?",
50 | "default": True,
51 | },
52 | ]
53 | are_you_sure_check = prompt(are_you_sure)
54 | if not are_you_sure_check.get("are_you_sure"):
55 | options.start_menu()
56 | else:
57 | answers = prompt(questions)
58 | try:
59 | git_user.create_repo(
60 | name=answers.get("repo_name"),
61 | description=answers.get("repo_desc"),
62 | private=answers.get("repo_private"),
63 | )
64 | except GithubException:
65 | error("Something went wrong! Please try again")
66 | options.start_menu()
67 | else:
68 | success(
69 | f'Repo created at -> https://github.com/{git_user.login}/{answers.get("repo_name")}'
70 | )
71 | webbrowser.open(
72 | f'https://github.com/{git_user.login}/{answers.get("repo_name")}'
73 | )
74 | options.start_menu()
75 |
--------------------------------------------------------------------------------
/.github/workflows/codeql-analysis.yml:
--------------------------------------------------------------------------------
1 | # For most projects, this workflow file will not need changing; you simply need
2 | # to commit it to your repository.
3 | #
4 | # You may wish to alter this file to override the set of languages analyzed,
5 | # or to provide custom queries or build logic.
6 | #
7 | # ******** NOTE ********
8 | # We have attempted to detect the languages in your repository. Please check
9 | # the `language` matrix defined below to confirm you have the correct set of
10 | # supported CodeQL languages.
11 | #
12 | name: "CodeQL"
13 |
14 | on:
15 | push:
16 | branches: [ master ]
17 | pull_request:
18 | # The branches below must be a subset of the branches above
19 | branches: [ master ]
20 | schedule:
21 | - cron: '45 17 * * 0'
22 |
23 | jobs:
24 | analyze:
25 | name: Analyze
26 | runs-on: ubuntu-latest
27 |
28 | strategy:
29 | fail-fast: false
30 | matrix:
31 | language: [ 'python' ]
32 | # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python' ]
33 | # Learn more:
34 | # https://docs.github.com/en/free-pro-team@latest/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning#changing-the-languages-that-are-analyzed
35 |
36 | steps:
37 | - name: Checkout repository
38 | uses: actions/checkout@v2
39 |
40 | # Initializes the CodeQL tools for scanning.
41 | - name: Initialize CodeQL
42 | uses: github/codeql-action/init@v1
43 | with:
44 | languages: ${{ matrix.language }}
45 | # If you wish to specify custom queries, you can do so here or in a config file.
46 | # By default, queries listed here will override any specified in a config file.
47 | # Prefix the list here with "+" to use these queries and those in the config file.
48 | # queries: ./path/to/local/query, your-org/your-repo/queries@main
49 |
50 | # Autobuild attempts to build any compiled languages (C/C++, C#, or Java).
51 | # If this step fails, then you should remove it and run the build manually (see below)
52 | - name: Autobuild
53 | uses: github/codeql-action/autobuild@v1
54 |
55 | # ℹ️ Command-line programs to run using the OS shell.
56 | # 📚 https://git.io/JvXDl
57 |
58 | # ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
59 | # and modify them (or add more) to build your code if your project
60 | # uses a compiled language
61 |
62 | #- run: |
63 | # make bootstrap
64 | # make release
65 |
66 | - name: Perform CodeQL Analysis
67 | uses: github/codeql-action/analyze@v1
68 |
--------------------------------------------------------------------------------
/better_git_cli/user.py:
--------------------------------------------------------------------------------
1 | """
2 | All the functions and menus for managing user details and settings
3 | """
4 |
5 | from PyInquirer import Separator, prompt
6 | from better_git_cli.helpers import *
7 | import better_git_cli.options as options
8 |
9 |
10 | def change_user_details():
11 |
12 | git_user = github().get_user()
13 |
14 | list_options = [
15 | {
16 | "type": "list",
17 | "name": "user_mng",
18 | "message": f"{github().get_user().name}, what would you like to do?",
19 | "choices": [
20 | {"name": "Change my location", "value": 1},
21 | {"name": "Change my name", "value": 2},
22 | {"name": "Change my website URL", "value": 3},
23 | {"name": "Change my bio", "value": 4},
24 | Separator(),
25 | {"name": "Return to main menu", "value": 5},
26 | {"name": "Exit to shell", "value": 6},
27 | ],
28 | }
29 | ]
30 |
31 | answers = prompt(list_options)
32 |
33 | if answers.get("user_mng") == 1:
34 | print(f"Current location: {git_user.location}")
35 | new_location = input("Please provide a new location: ")
36 | if new_location:
37 | git_user.edit(location=new_location)
38 | success("Location changed successfully")
39 | else:
40 | error("ERROR: Location cannot be empty")
41 |
42 | elif answers.get("user_mng") == 2:
43 | new_name = input(
44 | f"{git_user.name}, please provide a new name for your profile: "
45 | )
46 | if new_name:
47 | git_user.edit(name=new_name)
48 | success("Name changed successfully")
49 | else:
50 | error("ERROR: Name cannot be empty")
51 |
52 | elif answers.get("user_mng") == 3:
53 | print(f"Current website URL: {git_user.blog}")
54 | new_url = input("Please provide a new URL: ")
55 | if new_url:
56 | git_user.edit(blog=new_url)
57 | success("Website URL changed successfully")
58 | else:
59 | error("ERROR: URL cannot be empty")
60 |
61 | elif answers.get("user_mng") == 4:
62 | print(f"Current bio: {git_user.bio}")
63 | new_bio = input("Please provide your new bio: ")
64 | if new_bio:
65 | git_user.edit(bio=new_bio)
66 | success("Bio updated successfully")
67 | else:
68 | error("ERROR: Bio cannot be empty")
69 |
70 | elif answers.get("user_mng") == 5:
71 | options.start_menu()
72 |
73 | elif answers.get("user_mng") == 6:
74 | exit("Exiting now - see you later! 👋🏼")
75 |
76 | change_user_details()
77 |
--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
1 | # Byte-compiled / optimized / DLL files
2 | __pycache__/
3 | *.py[cod]
4 | *$py.class
5 |
6 | # C extensions
7 | *.so
8 |
9 | .idea
10 |
11 | # Distribution / packaging
12 | .Python
13 | build/
14 | develop-eggs/
15 | dist/
16 | downloads/
17 | eggs/
18 | .eggs/
19 | lib/
20 | lib64/
21 | parts/
22 | sdist/
23 | var/
24 | wheels/
25 | share/python-wheels/
26 | *.egg-info/
27 | .installed.cfg
28 | *.egg
29 | MANIFEST
30 |
31 | # PyInstaller
32 | # Usually these files are written by a python script from a template
33 | # before PyInstaller builds the exe, so as to inject date/other infos into it.
34 | *.manifest
35 | *.spec
36 |
37 | # Installer logs
38 | pip-log.txt
39 | pip-delete-this-directory.txt
40 |
41 | # Unit test / coverage reports
42 | htmlcov/
43 | .tox/
44 | .nox/
45 | .coverage
46 | .coverage.*
47 | .cache
48 | nosetests.xml
49 | coverage.xml
50 | *.cover
51 | *.py,cover
52 | .hypothesis/
53 | .pytest_cache/
54 | cover/
55 |
56 | # Translations
57 | *.mo
58 | *.pot
59 |
60 | # Django stuff:
61 | *.log
62 | local_settings.py
63 | db.sqlite3
64 | db.sqlite3-journal
65 |
66 | # Flask stuff:
67 | instance/
68 | .webassets-cache
69 |
70 | # Scrapy stuff:
71 | .scrapy
72 |
73 | # Sphinx documentation
74 | docs/_build/
75 |
76 | # PyBuilder
77 | .pybuilder/
78 | target/
79 |
80 | # Jupyter Notebook
81 | .ipynb_checkpoints
82 |
83 | # IPython
84 | profile_default/
85 | ipython_config.py
86 |
87 | # pyenv
88 | # For a library or package, you might want to ignore these files since the code is
89 | # intended to run in multiple environments; otherwise, check them in:
90 | # .python-version
91 |
92 | # pipenv
93 | # According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
94 | # However, in case of collaboration, if having platform-specific dependencies or dependencies
95 | # having no cross-platform support, pipenv may install dependencies that don't work, or not
96 | # install all needed dependencies.
97 | #Pipfile.lock
98 |
99 | # PEP 582; used by e.g. github.com/David-OConnor/pyflow
100 | __pypackages__/
101 |
102 | # Celery stuff
103 | celerybeat-schedule
104 | celerybeat.pid
105 |
106 | # SageMath parsed files
107 | *.sage.py
108 |
109 | # Environments
110 | .env
111 | .venv
112 | env/
113 | venv/
114 | ENV/
115 | env.bak/
116 | venv.bak/
117 |
118 | # Spyder project settings
119 | .spyderproject
120 | .spyproject
121 |
122 | # Rope project settings
123 | .ropeproject
124 |
125 | # mkdocs documentation
126 | /site
127 |
128 | # mypy
129 | .mypy_cache/
130 | .dmypy.json
131 | dmypy.json
132 |
133 | # Pyre type checker
134 | .pyre/
135 |
136 | # pytype static type analyzer
137 | .pytype/
138 |
139 | # Cython debug symbols
140 | cython_debug/
--------------------------------------------------------------------------------
/better_git_cli/sshkeys.py:
--------------------------------------------------------------------------------
1 | """
2 | All the functions and menus for managing and deleting user's SSH keys
3 | """
4 |
5 | from PyInquirer import Separator, prompt
6 | from better_git_cli.helpers import *
7 | import better_git_cli.options as options
8 | from github import GithubException
9 |
10 |
11 | def manage_ssh_keys():
12 |
13 | git_user = github().get_user()
14 |
15 | list_options = [
16 | {
17 | "type": "list",
18 | "name": "ssh_keys",
19 | "message": "What would you like to do?",
20 | "choices": [
21 | {"name": "View my SSH keys", "value": 1},
22 | {"name": "Delete SSH keys", "value": 2},
23 | {"name": "Create a new SSH key", "value": 3},
24 | Separator(),
25 | {"name": "Return to main menu", "value": 4},
26 | {"name": "Exit to shell", "value": 5},
27 | ],
28 | }
29 | ]
30 |
31 | answers = prompt(list_options)
32 |
33 | if answers.get("ssh_keys") == 1:
34 | if git_user.get_keys().totalCount == 0:
35 | print("Nothing to display.")
36 | manage_ssh_keys()
37 | else:
38 | print("Getting your SSH keys...")
39 | for key in git_user.get_keys():
40 | print("--------------------")
41 | print(f"KEY: {key.key}\nID: {key.id}\nNAME: {key.title}")
42 | print("--------------------")
43 |
44 | if answers.get("ssh_keys") == 2:
45 | if git_user.get_keys().totalCount == 0:
46 | print("You do not have any keys configured.")
47 | manage_ssh_keys()
48 | else:
49 | keys = []
50 | for key in git_user.get_keys():
51 | keys.append(
52 | {
53 | "name": f"KEY: {key.title}",
54 | "value": key.id,
55 | }
56 | )
57 | keys.extend(
58 | (
59 | Separator(),
60 | {"name": "Return to main menu", "value": "exit_menu"},
61 | {"name": "Exit to shell", "value": "exit_shell"},
62 | )
63 | )
64 |
65 | question = {
66 | "type": "list",
67 | "name": "delete_key",
68 | "message": "Choose a key to delete down below.",
69 | "choices": keys,
70 | }
71 |
72 | ssh_delete = prompt(question)
73 |
74 | if ssh_delete.get("delete_key") == "exit_menu":
75 | options.start_menu()
76 | elif ssh_delete.get("delete_key") == "exit_shell":
77 | exit("Exiting now - see you later! 👋🏼")
78 |
79 | warning = {
80 | "type": "confirm",
81 | "message": f'Are you sure you want to delete key with ID {ssh_delete.get("delete_key")}?',
82 | "name": "continue",
83 | "default": True,
84 | }
85 |
86 | warning_answer = prompt(warning)
87 |
88 | if warning_answer.get("continue") is True:
89 | git_user.get_key(ssh_delete.get("delete_key")).delete()
90 | success(
91 | f'Key with ID {ssh_delete.get("delete_key")} successfully deleted.'
92 | )
93 | else:
94 | manage_ssh_keys()
95 |
96 | elif answers.get("ssh_keys") == 3:
97 | are_you_sure = {
98 | "type": "confirm",
99 | "name": "are_you_sure",
100 | "message": "Are you sure you want to add a new SSH key?",
101 | "default": False,
102 | }
103 |
104 | questions = [
105 | {
106 | "type": "input",
107 | "name": "name",
108 | "message": "Please provide a title:",
109 | },
110 | {
111 | "type": "input",
112 | "name": "value",
113 | "message": "Please provide the generated key:",
114 | },
115 | ]
116 | are_you_sure_check = prompt(are_you_sure)
117 | if not are_you_sure_check.get("are_you_sure"):
118 | manage_ssh_keys()
119 | else:
120 | answers = prompt(questions)
121 | try:
122 | git_user.create_key(title=answers.get("name"), key=answers.get("value"))
123 | except GithubException:
124 | error(
125 | "ERROR: Something went wrong. Check that your key in OpenSSH public key format, or try again later."
126 | )
127 | manage_ssh_keys()
128 | else:
129 | success(f"'{answers.get('name')}' was created successfully!")
130 | manage_ssh_keys()
131 |
132 | elif answers.get("ssh_keys") == 4:
133 | options.start_menu()
134 |
135 | elif answers.get("ssh_keys") == 5:
136 | exit("Exiting now - see you later! 👋🏼")
137 |
138 | manage_ssh_keys()
139 |
--------------------------------------------------------------------------------
/better_git_cli/repos.py:
--------------------------------------------------------------------------------
1 | """
2 | All the functions and menus for managing user repositories
3 | """
4 |
5 | from PyInquirer import prompt, Separator
6 | from better_git_cli.helpers import *
7 | import better_git_cli.options as options
8 |
9 |
10 | def see_repos():
11 |
12 | # Fetch all users repos and return them as an array of options to pass to the selector menu
13 | def get_repos_as_options():
14 | repos = []
15 | if github().get_user().get_repos().totalCount >= 1:
16 | for repo in github().get_user().get_repos():
17 | repos.append({"name": repo.name, "value": repo.id})
18 | repos.extend(
19 | (
20 | Separator(),
21 | {"name": "Return to main menu", "value": 1},
22 | {"name": "Exit to shell", "value": 2},
23 | )
24 | )
25 | return repos
26 |
27 | # CHOOSE A REPOSITORY TO MANAGE
28 |
29 | question = {
30 | "type": "list",
31 | "name": "repo",
32 | "message": "Choose a repository",
33 | "choices": get_repos_as_options(),
34 | }
35 |
36 | if len(get_repos_as_options()):
37 | repo_list_answer = prompt(question)
38 | else:
39 | error("No repositories to display")
40 |
41 | if repo_list_answer.get("repo") == 1:
42 | options.start_menu()
43 |
44 | elif repo_list_answer.get("repo") == 2:
45 | exit("Exiting now - see you later! 👋🏼")
46 |
47 | repo = github().get_repo(repo_list_answer.get("repo"))
48 |
49 | # WHAT TO DO WITH CHOSEN REPO
50 | # (at this point the user have chosen one from list)
51 |
52 | question2 = {
53 | "type": "list",
54 | "name": "repo_mng",
55 | "message": f"What would you like to do with {repo.name}",
56 | "choices": [
57 | {"name": "Change name", "value": 1},
58 | {"name": "Change description", "value": 2},
59 | {"name": "Change URL", "value": 3},
60 | {"name": "Change visibility", "value": 4},
61 | {"name": "Change default branch", "value": 5},
62 | {"name": "Delete this repository", "value": 6},
63 | Separator(),
64 | {"name": "Return to main menu", "value": 7},
65 | {"name": "Exit to shell", "value": 8},
66 | ],
67 | }
68 |
69 | repo_answer = prompt(question2)
70 |
71 | if repo_answer.get("repo_mng") == 1:
72 | new_name = input(f"Please provide a new name for {repo.name}: ")
73 | if new_name:
74 | repo.edit(name=new_name)
75 | success("Name changed successfully")
76 | else:
77 | error("ERROR: Name cannot be empty")
78 |
79 | elif repo_answer.get("repo_mng") == 2:
80 | print(f"Current description: {repo.description}")
81 | new_description = input("Please provide a new description: ")
82 | if new_description:
83 | repo.edit(description=new_description)
84 | success("Description changed successfully")
85 | else:
86 | error("ERROR: Description cannot be empty")
87 |
88 | elif repo_answer.get("repo_mng") == 3:
89 | print(f"Current URL: {repo.homepage}")
90 | new_url = input("Please provide a new URL: ")
91 | if new_url:
92 | repo.edit(homepage=new_url)
93 | success("URL changed successfully")
94 | else:
95 | error("ERROR: URL cannot be empty")
96 |
97 | elif repo_answer.get("repo_mng") == 4:
98 | print(f'Current visibility: {"Private" if repo.private else "Public"}')
99 | question3 = {
100 | "type": "list",
101 | "name": "vis",
102 | "message": "Choose visibility",
103 | "choices": [
104 | {"name": "Public", "value": False},
105 | {"name": "Private", "value": True},
106 | ],
107 | }
108 | vis_answer = prompt(question3)
109 | repo.edit(private=vis_answer.get("vis"))
110 | success("Visibility changed successfully")
111 |
112 | elif repo_answer.get("repo_mng") == 5:
113 | print(f"Current default branch: {repo.default_branch}")
114 | print(f"Available branches: {[i.name for i in repo.get_branches()]}")
115 | new_branch = input("Please provide the new default branch: ")
116 | if new_branch:
117 | repo.edit(default_branch=new_branch)
118 | success("Default branch changed successfully")
119 | else:
120 | error("ERROR: Branch name cannot be empty")
121 |
122 | elif repo_answer.get("repo_mng") == 6:
123 | warning = {
124 | "type": "confirm",
125 | "message": f"Are you sure you want to delete {repo.name}? This is irreversible!",
126 | "name": "continue",
127 | "default": True,
128 | }
129 | delete_answer = prompt(warning)
130 | if delete_answer.get("continue") is True:
131 | repo.delete()
132 | success(f"{repo.name} successfully deleted!")
133 |
134 | # Back to menu
135 | elif repo_answer.get("repo_mng") == 7:
136 | options.start_menu()
137 |
138 | # Exit the app
139 | elif repo_answer.get("repo_mng") == 8:
140 | exit("Exiting now - see you later! 👋🏼")
141 |
142 | see_repos()
143 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | 
2 |
3 |
4 |
5 | 
6 |
7 | 
8 | 
9 |
10 | 
11 |
12 | 
13 |
14 |
15 | > Disclaimer: BetterGitCLI is **not** official GitHub software, nor is it in any way affiliated with GitHub.
16 |
17 | BetterGitCli is a third party GitHub CLI made with Python, providing easier access to managing your
18 | GitHub account directly from your shell with simple and intuitive UI. It's based on [PyGithub](https://pypi.org/project/PyGithub/) which is a wrapper library around the official GitHub REST API.
19 |
20 | ## Configuration
21 |
22 | See below for instructions on how to configure BetterGitCLI. Note that Python 3.6 or higher is required to run this program.
23 |
24 | ### GitHub access
25 |
26 | In order to grant access to your GitHub account you will need to authenticate with your GitHub access token. You can find instructions
27 | on how to obtain it [here](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token).
28 |
29 | Your token must grant access to _"repo"_, _"user"_, _"delete_repo"_ and _"admin:public_key"_. After generating
30 | your token, export it as an environmental variable in your shell 👇🏻
31 |
32 | ```bash
33 | # bash / zsh
34 | $ export GITHUB_AUTH_TOKEN="token"
35 |
36 | # powershell
37 | $env:GITHUB_AUTH_TOKEN = "token"
38 | ```
39 |
40 | 🚨 BetterGitCLI will never store your access token, and it will *only be stored locally* on your machine.
41 |
42 | ### Installation
43 | You can either install this program using [pip](https://pip.pypa.io/en/stable/installing/) or [pipenv](https://pipenv.pypa.io/en/latest/), or clone it and run locally with Python. Click on one of the
44 | options down below to reveal the instructions 👇🏻
45 |
46 |
47 | Install package with pip (preferred)
48 |
49 |
50 | Install BetterGitCLI using this command:
51 |
52 | ```bash
53 | $ pip install bettergitcli
54 | ```
55 |
56 | After installation, you can run it from anywhere in your shell 🎉
57 |
58 | ```bash
59 | $ bettergitcli
60 | ```
61 |
62 |
63 |
64 |
65 |
66 | Clone and run locally with Python
67 |
68 |
69 | If you prefer to clone this repository and run BetterGitCLI locally using your Python interpreter, you can
70 | do that as well. Just remember that in this case you will have to install these dependencies manually:
71 |
72 | - *PyInquirer, PyGithub, colorama*
73 |
74 | This can be done easily using the provided `requirements.txt` file by running this in the project root:
75 | ```bash
76 | $ pip install -r requirements.txt
77 | ```
78 |
79 | After installation, run the program inside the `/better_git_cli` directory:
80 |
81 | ```bash
82 | $ python main.py
83 | ```
84 |
85 |
86 |
87 |
88 |
89 | ## Usage
90 | To navigate the UI, use your arrow keys (up and down) and select options
91 | using Enter. You can also exit the program at any time by using the ^C (Ctrl+C) combination,
92 | or by choosing the _"Exit to shell"_ option.
93 |
94 | Via the UI, you can view all your repositories, manage branches and deployments, manage your
95 | personal user details and much more! **Current functions include**:
96 |
97 | - Repository management
98 | - View and edit repository details, such as the description, default branches, visibility and more!
99 | - Delete repositories
100 | - Create a new repository
101 | - User management
102 | - View and edit your personal details like your name, location or bio
103 | - SSH keys management
104 | - View, create and delete SSH keys linked to your GitHub account
105 | - Language statistics
106 | - See what your top languages are
107 |
108 |
109 | ## Preview 📲
110 |
111 | Some screenshots of BetterGitCLI in action 👇
112 |
113 | | Main Menu | Manage personal details | Manage a specific repo |
114 | | ----------- | ----------- | --------- |
115 | |  |  |  |
116 |
117 |
118 | ## Changelog
119 | You can view the changelog [here](https://github.com/PiotrRut/BetterGitCLI/blob/master/CHANGELOG.md).
120 |
121 | ## Contributing
122 | All contributions to add new features, fix any bugs (if you spot any) or make the code better or more efficient
123 | are more than welcome - please raise an [issue](https://github.com/PiotrRut/BetterGitCLI/issues/new) before you open a pull request
124 | to make sure we're not working on the same feature/bugfix! 💫
125 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | GNU GENERAL PUBLIC LICENSE
2 | Version 3, 29 June 2007
3 |
4 | Copyright (C) 2007 Free Software Foundation, Inc.
5 | Everyone is permitted to copy and distribute verbatim copies
6 | of this license document, but changing it is not allowed.
7 |
8 | Preamble
9 |
10 | The GNU General Public License is a free, copyleft license for
11 | software and other kinds of works.
12 |
13 | The licenses for most software and other practical works are designed
14 | to take away your freedom to share and change the works. By contrast,
15 | the GNU General Public License is intended to guarantee your freedom to
16 | share and change all versions of a program--to make sure it remains free
17 | software for all its users. We, the Free Software Foundation, use the
18 | GNU General Public License for most of our software; it applies also to
19 | any other work released this way by its authors. You can apply it to
20 | your programs, too.
21 |
22 | When we speak of free software, we are referring to freedom, not
23 | price. Our General Public Licenses are designed to make sure that you
24 | have the freedom to distribute copies of free software (and charge for
25 | them if you wish), that you receive source code or can get it if you
26 | want it, that you can change the software or use pieces of it in new
27 | free programs, and that you know you can do these things.
28 |
29 | To protect your rights, we need to prevent others from denying you
30 | these rights or asking you to surrender the rights. Therefore, you have
31 | certain responsibilities if you distribute copies of the software, or if
32 | you modify it: responsibilities to respect the freedom of others.
33 |
34 | For example, if you distribute copies of such a program, whether
35 | gratis or for a fee, you must pass on to the recipients the same
36 | freedoms that you received. You must make sure that they, too, receive
37 | or can get the source code. And you must show them these terms so they
38 | know their rights.
39 |
40 | Developers that use the GNU GPL protect your rights with two steps:
41 | (1) assert copyright on the software, and (2) offer you this License
42 | giving you legal permission to copy, distribute and/or modify it.
43 |
44 | For the developers' and authors' protection, the GPL clearly explains
45 | that there is no warranty for this free software. For both users' and
46 | authors' sake, the GPL requires that modified versions be marked as
47 | changed, so that their problems will not be attributed erroneously to
48 | authors of previous versions.
49 |
50 | Some devices are designed to deny users access to install or run
51 | modified versions of the software inside them, although the manufacturer
52 | can do so. This is fundamentally incompatible with the aim of
53 | protecting users' freedom to change the software. The systematic
54 | pattern of such abuse occurs in the area of products for individuals to
55 | use, which is precisely where it is most unacceptable. Therefore, we
56 | have designed this version of the GPL to prohibit the practice for those
57 | products. If such problems arise substantially in other domains, we
58 | stand ready to extend this provision to those domains in future versions
59 | of the GPL, as needed to protect the freedom of users.
60 |
61 | Finally, every program is threatened constantly by software patents.
62 | States should not allow patents to restrict development and use of
63 | software on general-purpose computers, but in those that do, we wish to
64 | avoid the special danger that patents applied to a free program could
65 | make it effectively proprietary. To prevent this, the GPL assures that
66 | patents cannot be used to render the program non-free.
67 |
68 | The precise terms and conditions for copying, distribution and
69 | modification follow.
70 |
71 | TERMS AND CONDITIONS
72 |
73 | 0. Definitions.
74 |
75 | "This License" refers to version 3 of the GNU General Public License.
76 |
77 | "Copyright" also means copyright-like laws that apply to other kinds of
78 | works, such as semiconductor masks.
79 |
80 | "The Program" refers to any copyrightable work licensed under this
81 | License. Each licensee is addressed as "you". "Licensees" and
82 | "recipients" may be individuals or organizations.
83 |
84 | To "modify" a work means to copy from or adapt all or part of the work
85 | in a fashion requiring copyright permission, other than the making of an
86 | exact copy. The resulting work is called a "modified version" of the
87 | earlier work or a work "based on" the earlier work.
88 |
89 | A "covered work" means either the unmodified Program or a work based
90 | on the Program.
91 |
92 | To "propagate" a work means to do anything with it that, without
93 | permission, would make you directly or secondarily liable for
94 | infringement under applicable copyright law, except executing it on a
95 | computer or modifying a private copy. Propagation includes copying,
96 | distribution (with or without modification), making available to the
97 | public, and in some countries other activities as well.
98 |
99 | To "convey" a work means any kind of propagation that enables other
100 | parties to make or receive copies. Mere interaction with a user through
101 | a computer network, with no transfer of a copy, is not conveying.
102 |
103 | An interactive user interface displays "Appropriate Legal Notices"
104 | to the extent that it includes a convenient and prominently visible
105 | feature that (1) displays an appropriate copyright notice, and (2)
106 | tells the user that there is no warranty for the work (except to the
107 | extent that warranties are provided), that licensees may convey the
108 | work under this License, and how to view a copy of this License. If
109 | the interface presents a list of user commands or options, such as a
110 | menu, a prominent item in the list meets this criterion.
111 |
112 | 1. Source Code.
113 |
114 | The "source code" for a work means the preferred form of the work
115 | for making modifications to it. "Object code" means any non-source
116 | form of a work.
117 |
118 | A "Standard Interface" means an interface that either is an official
119 | standard defined by a recognized standards body, or, in the case of
120 | interfaces specified for a particular programming language, one that
121 | is widely used among developers working in that language.
122 |
123 | The "System Libraries" of an executable work include anything, other
124 | than the work as a whole, that (a) is included in the normal form of
125 | packaging a Major Component, but which is not part of that Major
126 | Component, and (b) serves only to enable use of the work with that
127 | Major Component, or to implement a Standard Interface for which an
128 | implementation is available to the public in source code form. A
129 | "Major Component", in this context, means a major essential component
130 | (kernel, window system, and so on) of the specific operating system
131 | (if any) on which the executable work runs, or a compiler used to
132 | produce the work, or an object code interpreter used to run it.
133 |
134 | The "Corresponding Source" for a work in object code form means all
135 | the source code needed to generate, install, and (for an executable
136 | work) run the object code and to modify the work, including scripts to
137 | control those activities. However, it does not include the work's
138 | System Libraries, or general-purpose tools or generally available free
139 | programs which are used unmodified in performing those activities but
140 | which are not part of the work. For example, Corresponding Source
141 | includes interface definition files associated with source files for
142 | the work, and the source code for shared libraries and dynamically
143 | linked subprograms that the work is specifically designed to require,
144 | such as by intimate data communication or control flow between those
145 | subprograms and other parts of the work.
146 |
147 | The Corresponding Source need not include anything that users
148 | can regenerate automatically from other parts of the Corresponding
149 | Source.
150 |
151 | The Corresponding Source for a work in source code form is that
152 | same work.
153 |
154 | 2. Basic Permissions.
155 |
156 | All rights granted under this License are granted for the term of
157 | copyright on the Program, and are irrevocable provided the stated
158 | conditions are met. This License explicitly affirms your unlimited
159 | permission to run the unmodified Program. The output from running a
160 | covered work is covered by this License only if the output, given its
161 | content, constitutes a covered work. This License acknowledges your
162 | rights of fair use or other equivalent, as provided by copyright law.
163 |
164 | You may make, run and propagate covered works that you do not
165 | convey, without conditions so long as your license otherwise remains
166 | in force. You may convey covered works to others for the sole purpose
167 | of having them make modifications exclusively for you, or provide you
168 | with facilities for running those works, provided that you comply with
169 | the terms of this License in conveying all material for which you do
170 | not control copyright. Those thus making or running the covered works
171 | for you must do so exclusively on your behalf, under your direction
172 | and control, on terms that prohibit them from making any copies of
173 | your copyrighted material outside their relationship with you.
174 |
175 | Conveying under any other circumstances is permitted solely under
176 | the conditions stated below. Sublicensing is not allowed; section 10
177 | makes it unnecessary.
178 |
179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
180 |
181 | No covered work shall be deemed part of an effective technological
182 | measure under any applicable law fulfilling obligations under article
183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or
184 | similar laws prohibiting or restricting circumvention of such
185 | measures.
186 |
187 | When you convey a covered work, you waive any legal power to forbid
188 | circumvention of technological measures to the extent such circumvention
189 | is effected by exercising rights under this License with respect to
190 | the covered work, and you disclaim any intention to limit operation or
191 | modification of the work as a means of enforcing, against the work's
192 | users, your or third parties' legal rights to forbid circumvention of
193 | technological measures.
194 |
195 | 4. Conveying Verbatim Copies.
196 |
197 | You may convey verbatim copies of the Program's source code as you
198 | receive it, in any medium, provided that you conspicuously and
199 | appropriately publish on each copy an appropriate copyright notice;
200 | keep intact all notices stating that this License and any
201 | non-permissive terms added in accord with section 7 apply to the code;
202 | keep intact all notices of the absence of any warranty; and give all
203 | recipients a copy of this License along with the Program.
204 |
205 | You may charge any price or no price for each copy that you convey,
206 | and you may offer support or warranty protection for a fee.
207 |
208 | 5. Conveying Modified Source Versions.
209 |
210 | You may convey a work based on the Program, or the modifications to
211 | produce it from the Program, in the form of source code under the
212 | terms of section 4, provided that you also meet all of these conditions:
213 |
214 | a) The work must carry prominent notices stating that you modified
215 | it, and giving a relevant date.
216 |
217 | b) The work must carry prominent notices stating that it is
218 | released under this License and any conditions added under section
219 | 7. This requirement modifies the requirement in section 4 to
220 | "keep intact all notices".
221 |
222 | c) You must license the entire work, as a whole, under this
223 | License to anyone who comes into possession of a copy. This
224 | License will therefore apply, along with any applicable section 7
225 | additional terms, to the whole of the work, and all its parts,
226 | regardless of how they are packaged. This License gives no
227 | permission to license the work in any other way, but it does not
228 | invalidate such permission if you have separately received it.
229 |
230 | d) If the work has interactive user interfaces, each must display
231 | Appropriate Legal Notices; however, if the Program has interactive
232 | interfaces that do not display Appropriate Legal Notices, your
233 | work need not make them do so.
234 |
235 | A compilation of a covered work with other separate and independent
236 | works, which are not by their nature extensions of the covered work,
237 | and which are not combined with it such as to form a larger program,
238 | in or on a volume of a storage or distribution medium, is called an
239 | "aggregate" if the compilation and its resulting copyright are not
240 | used to limit the access or legal rights of the compilation's users
241 | beyond what the individual works permit. Inclusion of a covered work
242 | in an aggregate does not cause this License to apply to the other
243 | parts of the aggregate.
244 |
245 | 6. Conveying Non-Source Forms.
246 |
247 | You may convey a covered work in object code form under the terms
248 | of sections 4 and 5, provided that you also convey the
249 | machine-readable Corresponding Source under the terms of this License,
250 | in one of these ways:
251 |
252 | a) Convey the object code in, or embodied in, a physical product
253 | (including a physical distribution medium), accompanied by the
254 | Corresponding Source fixed on a durable physical medium
255 | customarily used for software interchange.
256 |
257 | b) Convey the object code in, or embodied in, a physical product
258 | (including a physical distribution medium), accompanied by a
259 | written offer, valid for at least three years and valid for as
260 | long as you offer spare parts or customer support for that product
261 | model, to give anyone who possesses the object code either (1) a
262 | copy of the Corresponding Source for all the software in the
263 | product that is covered by this License, on a durable physical
264 | medium customarily used for software interchange, for a price no
265 | more than your reasonable cost of physically performing this
266 | conveying of source, or (2) access to copy the
267 | Corresponding Source from a network server at no charge.
268 |
269 | c) Convey individual copies of the object code with a copy of the
270 | written offer to provide the Corresponding Source. This
271 | alternative is allowed only occasionally and noncommercially, and
272 | only if you received the object code with such an offer, in accord
273 | with subsection 6b.
274 |
275 | d) Convey the object code by offering access from a designated
276 | place (gratis or for a charge), and offer equivalent access to the
277 | Corresponding Source in the same way through the same place at no
278 | further charge. You need not require recipients to copy the
279 | Corresponding Source along with the object code. If the place to
280 | copy the object code is a network server, the Corresponding Source
281 | may be on a different server (operated by you or a third party)
282 | that supports equivalent copying facilities, provided you maintain
283 | clear directions next to the object code saying where to find the
284 | Corresponding Source. Regardless of what server hosts the
285 | Corresponding Source, you remain obligated to ensure that it is
286 | available for as long as needed to satisfy these requirements.
287 |
288 | e) Convey the object code using peer-to-peer transmission, provided
289 | you inform other peers where the object code and Corresponding
290 | Source of the work are being offered to the general public at no
291 | charge under subsection 6d.
292 |
293 | A separable portion of the object code, whose source code is excluded
294 | from the Corresponding Source as a System Library, need not be
295 | included in conveying the object code work.
296 |
297 | A "User Product" is either (1) a "consumer product", which means any
298 | tangible personal property which is normally used for personal, family,
299 | or household purposes, or (2) anything designed or sold for incorporation
300 | into a dwelling. In determining whether a product is a consumer product,
301 | doubtful cases shall be resolved in favor of coverage. For a particular
302 | product received by a particular user, "normally used" refers to a
303 | typical or common use of that class of product, regardless of the status
304 | of the particular user or of the way in which the particular user
305 | actually uses, or expects or is expected to use, the product. A product
306 | is a consumer product regardless of whether the product has substantial
307 | commercial, industrial or non-consumer uses, unless such uses represent
308 | the only significant mode of use of the product.
309 |
310 | "Installation Information" for a User Product means any methods,
311 | procedures, authorization keys, or other information required to install
312 | and execute modified versions of a covered work in that User Product from
313 | a modified version of its Corresponding Source. The information must
314 | suffice to ensure that the continued functioning of the modified object
315 | code is in no case prevented or interfered with solely because
316 | modification has been made.
317 |
318 | If you convey an object code work under this section in, or with, or
319 | specifically for use in, a User Product, and the conveying occurs as
320 | part of a transaction in which the right of possession and use of the
321 | User Product is transferred to the recipient in perpetuity or for a
322 | fixed term (regardless of how the transaction is characterized), the
323 | Corresponding Source conveyed under this section must be accompanied
324 | by the Installation Information. But this requirement does not apply
325 | if neither you nor any third party retains the ability to install
326 | modified object code on the User Product (for example, the work has
327 | been installed in ROM).
328 |
329 | The requirement to provide Installation Information does not include a
330 | requirement to continue to provide support service, warranty, or updates
331 | for a work that has been modified or installed by the recipient, or for
332 | the User Product in which it has been modified or installed. Access to a
333 | network may be denied when the modification itself materially and
334 | adversely affects the operation of the network or violates the rules and
335 | protocols for communication across the network.
336 |
337 | Corresponding Source conveyed, and Installation Information provided,
338 | in accord with this section must be in a format that is publicly
339 | documented (and with an implementation available to the public in
340 | source code form), and must require no special password or key for
341 | unpacking, reading or copying.
342 |
343 | 7. Additional Terms.
344 |
345 | "Additional permissions" are terms that supplement the terms of this
346 | License by making exceptions from one or more of its conditions.
347 | Additional permissions that are applicable to the entire Program shall
348 | be treated as though they were included in this License, to the extent
349 | that they are valid under applicable law. If additional permissions
350 | apply only to part of the Program, that part may be used separately
351 | under those permissions, but the entire Program remains governed by
352 | this License without regard to the additional permissions.
353 |
354 | When you convey a copy of a covered work, you may at your option
355 | remove any additional permissions from that copy, or from any part of
356 | it. (Additional permissions may be written to require their own
357 | removal in certain cases when you modify the work.) You may place
358 | additional permissions on material, added by you to a covered work,
359 | for which you have or can give appropriate copyright permission.
360 |
361 | Notwithstanding any other provision of this License, for material you
362 | add to a covered work, you may (if authorized by the copyright holders of
363 | that material) supplement the terms of this License with terms:
364 |
365 | a) Disclaiming warranty or limiting liability differently from the
366 | terms of sections 15 and 16 of this License; or
367 |
368 | b) Requiring preservation of specified reasonable legal notices or
369 | author attributions in that material or in the Appropriate Legal
370 | Notices displayed by works containing it; or
371 |
372 | c) Prohibiting misrepresentation of the origin of that material, or
373 | requiring that modified versions of such material be marked in
374 | reasonable ways as different from the original version; or
375 |
376 | d) Limiting the use for publicity purposes of names of licensors or
377 | authors of the material; or
378 |
379 | e) Declining to grant rights under trademark law for use of some
380 | trade names, trademarks, or service marks; or
381 |
382 | f) Requiring indemnification of licensors and authors of that
383 | material by anyone who conveys the material (or modified versions of
384 | it) with contractual assumptions of liability to the recipient, for
385 | any liability that these contractual assumptions directly impose on
386 | those licensors and authors.
387 |
388 | All other non-permissive additional terms are considered "further
389 | restrictions" within the meaning of section 10. If the Program as you
390 | received it, or any part of it, contains a notice stating that it is
391 | governed by this License along with a term that is a further
392 | restriction, you may remove that term. If a license document contains
393 | a further restriction but permits relicensing or conveying under this
394 | License, you may add to a covered work material governed by the terms
395 | of that license document, provided that the further restriction does
396 | not survive such relicensing or conveying.
397 |
398 | If you add terms to a covered work in accord with this section, you
399 | must place, in the relevant source files, a statement of the
400 | additional terms that apply to those files, or a notice indicating
401 | where to find the applicable terms.
402 |
403 | Additional terms, permissive or non-permissive, may be stated in the
404 | form of a separately written license, or stated as exceptions;
405 | the above requirements apply either way.
406 |
407 | 8. Termination.
408 |
409 | You may not propagate or modify a covered work except as expressly
410 | provided under this License. Any attempt otherwise to propagate or
411 | modify it is void, and will automatically terminate your rights under
412 | this License (including any patent licenses granted under the third
413 | paragraph of section 11).
414 |
415 | However, if you cease all violation of this License, then your
416 | license from a particular copyright holder is reinstated (a)
417 | provisionally, unless and until the copyright holder explicitly and
418 | finally terminates your license, and (b) permanently, if the copyright
419 | holder fails to notify you of the violation by some reasonable means
420 | prior to 60 days after the cessation.
421 |
422 | Moreover, your license from a particular copyright holder is
423 | reinstated permanently if the copyright holder notifies you of the
424 | violation by some reasonable means, this is the first time you have
425 | received notice of violation of this License (for any work) from that
426 | copyright holder, and you cure the violation prior to 30 days after
427 | your receipt of the notice.
428 |
429 | Termination of your rights under this section does not terminate the
430 | licenses of parties who have received copies or rights from you under
431 | this License. If your rights have been terminated and not permanently
432 | reinstated, you do not qualify to receive new licenses for the same
433 | material under section 10.
434 |
435 | 9. Acceptance Not Required for Having Copies.
436 |
437 | You are not required to accept this License in order to receive or
438 | run a copy of the Program. Ancillary propagation of a covered work
439 | occurring solely as a consequence of using peer-to-peer transmission
440 | to receive a copy likewise does not require acceptance. However,
441 | nothing other than this License grants you permission to propagate or
442 | modify any covered work. These actions infringe copyright if you do
443 | not accept this License. Therefore, by modifying or propagating a
444 | covered work, you indicate your acceptance of this License to do so.
445 |
446 | 10. Automatic Licensing of Downstream Recipients.
447 |
448 | Each time you convey a covered work, the recipient automatically
449 | receives a license from the original licensors, to run, modify and
450 | propagate that work, subject to this License. You are not responsible
451 | for enforcing compliance by third parties with this License.
452 |
453 | An "entity transaction" is a transaction transferring control of an
454 | organization, or substantially all assets of one, or subdividing an
455 | organization, or merging organizations. If propagation of a covered
456 | work results from an entity transaction, each party to that
457 | transaction who receives a copy of the work also receives whatever
458 | licenses to the work the party's predecessor in interest had or could
459 | give under the previous paragraph, plus a right to possession of the
460 | Corresponding Source of the work from the predecessor in interest, if
461 | the predecessor has it or can get it with reasonable efforts.
462 |
463 | You may not impose any further restrictions on the exercise of the
464 | rights granted or affirmed under this License. For example, you may
465 | not impose a license fee, royalty, or other charge for exercise of
466 | rights granted under this License, and you may not initiate litigation
467 | (including a cross-claim or counterclaim in a lawsuit) alleging that
468 | any patent claim is infringed by making, using, selling, offering for
469 | sale, or importing the Program or any portion of it.
470 |
471 | 11. Patents.
472 |
473 | A "contributor" is a copyright holder who authorizes use under this
474 | License of the Program or a work on which the Program is based. The
475 | work thus licensed is called the contributor's "contributor version".
476 |
477 | A contributor's "essential patent claims" are all patent claims
478 | owned or controlled by the contributor, whether already acquired or
479 | hereafter acquired, that would be infringed by some manner, permitted
480 | by this License, of making, using, or selling its contributor version,
481 | but do not include claims that would be infringed only as a
482 | consequence of further modification of the contributor version. For
483 | purposes of this definition, "control" includes the right to grant
484 | patent sublicenses in a manner consistent with the requirements of
485 | this License.
486 |
487 | Each contributor grants you a non-exclusive, worldwide, royalty-free
488 | patent license under the contributor's essential patent claims, to
489 | make, use, sell, offer for sale, import and otherwise run, modify and
490 | propagate the contents of its contributor version.
491 |
492 | In the following three paragraphs, a "patent license" is any express
493 | agreement or commitment, however denominated, not to enforce a patent
494 | (such as an express permission to practice a patent or covenant not to
495 | sue for patent infringement). To "grant" such a patent license to a
496 | party means to make such an agreement or commitment not to enforce a
497 | patent against the party.
498 |
499 | If you convey a covered work, knowingly relying on a patent license,
500 | and the Corresponding Source of the work is not available for anyone
501 | to copy, free of charge and under the terms of this License, through a
502 | publicly available network server or other readily accessible means,
503 | then you must either (1) cause the Corresponding Source to be so
504 | available, or (2) arrange to deprive yourself of the benefit of the
505 | patent license for this particular work, or (3) arrange, in a manner
506 | consistent with the requirements of this License, to extend the patent
507 | license to downstream recipients. "Knowingly relying" means you have
508 | actual knowledge that, but for the patent license, your conveying the
509 | covered work in a country, or your recipient's use of the covered work
510 | in a country, would infringe one or more identifiable patents in that
511 | country that you have reason to believe are valid.
512 |
513 | If, pursuant to or in connection with a single transaction or
514 | arrangement, you convey, or propagate by procuring conveyance of, a
515 | covered work, and grant a patent license to some of the parties
516 | receiving the covered work authorizing them to use, propagate, modify
517 | or convey a specific copy of the covered work, then the patent license
518 | you grant is automatically extended to all recipients of the covered
519 | work and works based on it.
520 |
521 | A patent license is "discriminatory" if it does not include within
522 | the scope of its coverage, prohibits the exercise of, or is
523 | conditioned on the non-exercise of one or more of the rights that are
524 | specifically granted under this License. You may not convey a covered
525 | work if you are a party to an arrangement with a third party that is
526 | in the business of distributing software, under which you make payment
527 | to the third party based on the extent of your activity of conveying
528 | the work, and under which the third party grants, to any of the
529 | parties who would receive the covered work from you, a discriminatory
530 | patent license (a) in connection with copies of the covered work
531 | conveyed by you (or copies made from those copies), or (b) primarily
532 | for and in connection with specific products or compilations that
533 | contain the covered work, unless you entered into that arrangement,
534 | or that patent license was granted, prior to 28 March 2007.
535 |
536 | Nothing in this License shall be construed as excluding or limiting
537 | any implied license or other defenses to infringement that may
538 | otherwise be available to you under applicable patent law.
539 |
540 | 12. No Surrender of Others' Freedom.
541 |
542 | If conditions are imposed on you (whether by court order, agreement or
543 | otherwise) that contradict the conditions of this License, they do not
544 | excuse you from the conditions of this License. If you cannot convey a
545 | covered work so as to satisfy simultaneously your obligations under this
546 | License and any other pertinent obligations, then as a consequence you may
547 | not convey it at all. For example, if you agree to terms that obligate you
548 | to collect a royalty for further conveying from those to whom you convey
549 | the Program, the only way you could satisfy both those terms and this
550 | License would be to refrain entirely from conveying the Program.
551 |
552 | 13. Use with the GNU Affero General Public License.
553 |
554 | Notwithstanding any other provision of this License, you have
555 | permission to link or combine any covered work with a work licensed
556 | under version 3 of the GNU Affero General Public License into a single
557 | combined work, and to convey the resulting work. The terms of this
558 | License will continue to apply to the part which is the covered work,
559 | but the special requirements of the GNU Affero General Public License,
560 | section 13, concerning interaction through a network will apply to the
561 | combination as such.
562 |
563 | 14. Revised Versions of this License.
564 |
565 | The Free Software Foundation may publish revised and/or new versions of
566 | the GNU General Public License from time to time. Such new versions will
567 | be similar in spirit to the present version, but may differ in detail to
568 | address new problems or concerns.
569 |
570 | Each version is given a distinguishing version number. If the
571 | Program specifies that a certain numbered version of the GNU General
572 | Public License "or any later version" applies to it, you have the
573 | option of following the terms and conditions either of that numbered
574 | version or of any later version published by the Free Software
575 | Foundation. If the Program does not specify a version number of the
576 | GNU General Public License, you may choose any version ever published
577 | by the Free Software Foundation.
578 |
579 | If the Program specifies that a proxy can decide which future
580 | versions of the GNU General Public License can be used, that proxy's
581 | public statement of acceptance of a version permanently authorizes you
582 | to choose that version for the Program.
583 |
584 | Later license versions may give you additional or different
585 | permissions. However, no additional obligations are imposed on any
586 | author or copyright holder as a result of your choosing to follow a
587 | later version.
588 |
589 | 15. Disclaimer of Warranty.
590 |
591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
599 |
600 | 16. Limitation of Liability.
601 |
602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
610 | SUCH DAMAGES.
611 |
612 | 17. Interpretation of Sections 15 and 16.
613 |
614 | If the disclaimer of warranty and limitation of liability provided
615 | above cannot be given local legal effect according to their terms,
616 | reviewing courts shall apply local law that most closely approximates
617 | an absolute waiver of all civil liability in connection with the
618 | Program, unless a warranty or assumption of liability accompanies a
619 | copy of the Program in return for a fee.
620 |
621 | END OF TERMS AND CONDITIONS
622 |
623 | How to Apply These Terms to Your New Programs
624 |
625 | If you develop a new program, and you want it to be of the greatest
626 | possible use to the public, the best way to achieve this is to make it
627 | free software which everyone can redistribute and change under these terms.
628 |
629 | To do so, attach the following notices to the program. It is safest
630 | to attach them to the start of each source file to most effectively
631 | state the exclusion of warranty; and each file should have at least
632 | the "copyright" line and a pointer to where the full notice is found.
633 |
634 |
635 | Copyright (C)
636 |
637 | This program is free software: you can redistribute it and/or modify
638 | it under the terms of the GNU General Public License as published by
639 | the Free Software Foundation, either version 3 of the License, or
640 | (at your option) any later version.
641 |
642 | This program is distributed in the hope that it will be useful,
643 | but WITHOUT ANY WARRANTY; without even the implied warranty of
644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
645 | GNU General Public License for more details.
646 |
647 | You should have received a copy of the GNU General Public License
648 | along with this program. If not, see .
649 |
650 | Also add information on how to contact you by electronic and paper mail.
651 |
652 | If the program does terminal interaction, make it output a short
653 | notice like this when it starts in an interactive mode:
654 |
655 | Copyright (C)
656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
657 | This is free software, and you are welcome to redistribute it
658 | under certain conditions; type `show c' for details.
659 |
660 | The hypothetical commands `show w' and `show c' should show the appropriate
661 | parts of the General Public License. Of course, your program's commands
662 | might be different; for a GUI interface, you would use an "about box".
663 |
664 | You should also get your employer (if you work as a programmer) or school,
665 | if any, to sign a "copyright disclaimer" for the program, if necessary.
666 | For more information on this, and how to apply and follow the GNU GPL, see
667 | .
668 |
669 | The GNU General Public License does not permit incorporating your program
670 | into proprietary programs. If your program is a subroutine library, you
671 | may consider it more useful to permit linking proprietary applications with
672 | the library. If this is what you want to do, use the GNU Lesser General
673 | Public License instead of this License. But first, please read
674 | .
675 |
--------------------------------------------------------------------------------