pysubmodule

painless submodule manager


License
MIT
Install
pip install pysubmodule==0.1.1

Documentation

pysubmodule

  • 一个项目可能由多个子项目组成,而不少仍处于开发状态或插件形式的子项目并不能使用pip之类的形式进行管理,只能通过git clone项目解决
  • 这意味着每个父项目都需要重新写管理这些子项目的逻辑

设计

  • 利用json文件配置各个子项目
  • 插件式融合到大型项目中,同步更新依赖的子项目,不再需要分散注意力

怎么使用

  • 把需要的子项目配置在json文件中

    • url为git链接
    • path为项目位置,根目录默认为json文件所在的目录,键入.代表将子项目clone到json同级目录下
      {
        "tornado_demo": {
          "url": "https://github.com/williamfzc/tornado_demo.git",
          "path": ".",
          "desc": "JUST USE IT AS EXAMPLE"
        }
      }
      
    • 如果需要clone到特定位置,例如./abc/def目录下,则直接键入abc/def即可
      {
        "tornado_demo": {
          "url": "https://github.com/williamfzc/tornado_demo.git",
          "path": "abc/def",
          "desc": "JUST USE IT AS EXAMPLE"
        }
      }
      
    • desc为项目描述
  • 引用pysubmodule并在需要的地方调用sync

pysubmodule.sync('example.json')
  • 剩下的pysubmodule会替你完成