Skip to main content

Git Portfolio

Project description

PyPI Python Version License

Read the documentation at https://git-portfolio.readthedocs.io/ Tests Codecov

pre-commit Black

Features

  • Configure multiple working repositories.

  • Batch git commands with subcommands: add, branch, checkout, commit, diff, fetch, init, merge, mv, pull, push, rebase, reset, rm, show, switch, status and tag.

  • Batch API calls on GitHub: create/close/reopen issues, create/close/reopen/merge pull requests and delete branches by name.

  • Batch Poetry commands such as: add, version patch, install or update.

Requirements

  • Create an auth token for GitHub, with the repo privileges enabled by clicking on Generate new token. You will be asked to select scopes for the token. Which scopes you choose will determine what information and actions you will be able to perform against the API. You should be careful with the ones prefixed with write:, delete: and admin: as these might be quite destructive. You can find description of each scope in docs here.

Important: safeguard your token (once created you won’t be able to see it again).

  • Install git (optional) - this is needed for all git commands. For colored outputs please use the configuration:

$ git config --global color.ui always

Installation

You can install Git Portfolio via pip from PyPI:

$ pip install git-portfolio

Basic usage

  1. Create initial configuration with:

$ gitp config init
  1. Execute all the commands you want. Eg.:

$ gitp issues create  # create same issue for all projects
$ gitp checkout -b new-branch  # checks out new branch new-branch in all projects
$ gitp poetry version minor  # bumps minor version of all projects that have pyproject.toml version

Note: by convention GitHub commands are always the resource name and action: eg. branches delete, issues create and prs merge (for pull requests). This avoid conflicts with batch git commands, as in gitp branch (executes git command) and gitp branches delete (execute operations using GitHub API).

Complete instructions can be found at git-portfolio.readthedocs.io.

Contributing

Contributions are very welcome. To learn more, see the Contributor Guide.

License

Distributed under the terms of the MIT license, Git Portfolio is free and open source software.

Issues

If you encounter any problems, please file an issue along with a detailed description.

Credits

This project was generated from @cjolowicz’s Hypermodern Python Cookiecutter template.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

git_portfolio-1.1.1.tar.gz (18.3 kB view hashes)

Uploaded source

Built Distribution

git_portfolio-1.1.1-py3-none-any.whl (26.4 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page