Skip to content

Vaastav-Technologies/py-repoconf

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

25 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

py-repoconf

PyPI - Python Version PyPI - Types GitHub License πŸ”§ test πŸ’‘ typecheck πŸ› οΈ lint πŸ“Š coverage πŸ“€ Upload Python Package PyPI - Version


🧠 Centrally configure your decentralised πŸ™ git repo.

Git, being an awesomely decentralised system, has ways to have decentralised configurations per user. However, times require certain configurations to be shared and tracked centrally among various collaborators. Some examples of centrally sharable configurations are:

  • πŸ’» Branch descriptions (or better, branch READMEs).
  • πŸ’‘Issues/Features/Tasks related to the repo.
  • πŸͺΌ Certain properties that closely relate to the repo.
  • πŸ“• Rules related to per-branch collaborations and conventions.
  • πŸ”’ Encrypted secrets.
  • 🎁 Deployment, packaging and distribution mechanics.
  • ⬆️ ... and more

Repoconf is developed to address this issue. It stores central configuration in the __repoconf/default/main branch and this centrally stored distributed configuration can be:

  • 🟒 accessed using git config commands and aliases
  • βž• added
  • βž– removed
  • ↗️ pushed
  • ↙️ pulled

... just like any other git branches πŸ‘πŸ‘».

Quick Start

Command usage

  • List all the configurations for the current repo

    repoconf config --list
  • Add configuration

    repoconf config branch.my-branch.description "This branch is created for something which one may not readily remember in the future."
    repoconf config branch.my-sharable-branch.description "This branch is to be shared with others and thus requires concise description on what it is created for."

... supports nearly all options that git config command supports. See git config documentation for more details.

Installation

pip install repoconf

About

🧠 Centrally configure your decentralised πŸ™ git repo.

Topics

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages