Manage projects spread across multiple repositories
Project description
dev-pipeline
============
|codacy|
|code-climate|
A tool to help manage projects with dependencies spread across repositories.
Inspiration
-----------
I work on several projects spread across repositories; some of these leverage
sub-repositories in some form, and it's led to additional complexity trying to
stay in sync (especially when dealing with merges, release lines, hot fixes,
and all the other fun things that happen in large software projects). The
goal here is to have a suite of scripts to help keep repositories in sync and
working well together, without the issues that sub-repositories introduce.
Installation
------------
dev-pipeline requires python3; python2 will not work.
>From PyPi
~~~~~~~~~
The simplest way to install is using pip_.
.. code:: bash
$ pip3 install dev-pipeline
This will install the latest release. It won't be as up to date as what's in
source, but it should be more stable.
>From Source
~~~~~~~~~~~
If the version in PyPi_ isn't new enough, you can install directoy from source
using pip_. Because dev-pipeline is spread across several repositories (each
tool and plugin is tracked separately), you'll need to install all of them as
well (see their documentation). Dependencies are listed in `setup.py`_.
Once all dependencies are installed, you can install dev-pipeline using the
following commands:
.. code:: bash
$ cd /path/to/dev-pipeline
$ pip3 install
If you don't have pip available, you can run :code:`setup.py` directly.
.. code:: bash
$ cd /path/to/dev-pipeline
$ python3 setup.py install
If the install completes without errors, then you're good to go.
Using
-----
The first thing you'll need to do is write a `build configuration`_. Once
you're ready, a build directory.
.. code:: bash
# configure with default settings
$ dev-pipeline configure
If everything went well, you're ready to build.
.. code:: bash
# enter whatever directory the configure step used
$ cd build
# bootstrap will both pull the package sources and build them
$ dev-pipeline bootstrap
That's it. Check the tool documentation for information on what's available.
.. |codacy| image:: https://api.codacy.com/project/badge/Grade/0d9cf1d52ca846dc99de6cc621dfeb7b
:target: https://www.codacy.com/app/snewell/dev-pipeline?utm_source=github.com&utm_medium=referral&utm_content=dev-pipeline/dev-pipeline&utm_campaign=Badge_Grade
.. |code-climate| image:: https://api.codeclimate.com/v1/badges/9427722fafe270b6716f/maintainability
:target: https://codeclimate.com/github/dev-pipeline/dev-pipeline/maintainability
:alt: Maintainability
.. _build configuration: docs/config.rst
.. _pip: https://pypi.python.org/pypi/pip
.. _PyPi: https://pypi.org/project/dev-pipeline/
.. _setup.py: https://github.com/dev-pipeline/dev-pipeline/blob/master/setup.py
============
|codacy|
|code-climate|
A tool to help manage projects with dependencies spread across repositories.
Inspiration
-----------
I work on several projects spread across repositories; some of these leverage
sub-repositories in some form, and it's led to additional complexity trying to
stay in sync (especially when dealing with merges, release lines, hot fixes,
and all the other fun things that happen in large software projects). The
goal here is to have a suite of scripts to help keep repositories in sync and
working well together, without the issues that sub-repositories introduce.
Installation
------------
dev-pipeline requires python3; python2 will not work.
>From PyPi
~~~~~~~~~
The simplest way to install is using pip_.
.. code:: bash
$ pip3 install dev-pipeline
This will install the latest release. It won't be as up to date as what's in
source, but it should be more stable.
>From Source
~~~~~~~~~~~
If the version in PyPi_ isn't new enough, you can install directoy from source
using pip_. Because dev-pipeline is spread across several repositories (each
tool and plugin is tracked separately), you'll need to install all of them as
well (see their documentation). Dependencies are listed in `setup.py`_.
Once all dependencies are installed, you can install dev-pipeline using the
following commands:
.. code:: bash
$ cd /path/to/dev-pipeline
$ pip3 install
If you don't have pip available, you can run :code:`setup.py` directly.
.. code:: bash
$ cd /path/to/dev-pipeline
$ python3 setup.py install
If the install completes without errors, then you're good to go.
Using
-----
The first thing you'll need to do is write a `build configuration`_. Once
you're ready, a build directory.
.. code:: bash
# configure with default settings
$ dev-pipeline configure
If everything went well, you're ready to build.
.. code:: bash
# enter whatever directory the configure step used
$ cd build
# bootstrap will both pull the package sources and build them
$ dev-pipeline bootstrap
That's it. Check the tool documentation for information on what's available.
.. |codacy| image:: https://api.codacy.com/project/badge/Grade/0d9cf1d52ca846dc99de6cc621dfeb7b
:target: https://www.codacy.com/app/snewell/dev-pipeline?utm_source=github.com&utm_medium=referral&utm_content=dev-pipeline/dev-pipeline&utm_campaign=Badge_Grade
.. |code-climate| image:: https://api.codeclimate.com/v1/badges/9427722fafe270b6716f/maintainability
:target: https://codeclimate.com/github/dev-pipeline/dev-pipeline/maintainability
:alt: Maintainability
.. _build configuration: docs/config.rst
.. _pip: https://pypi.python.org/pypi/pip
.. _PyPi: https://pypi.org/project/dev-pipeline/
.. _setup.py: https://github.com/dev-pipeline/dev-pipeline/blob/master/setup.py
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
dev-pipeline-0.2.0a0.tar.gz
(3.3 kB
view hashes)
Built Distribution
Close
Hashes for dev_pipeline-0.2.0a0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | db5c5d8a3e74d7ed872a0b67995edf16e53ac55fb493a54fff8c64bbe44fdf19 |
|
MD5 | c77f8c1321a1aecc52bf32183ad21951 |
|
BLAKE2b-256 | 3215a6c2d1fa295c3ab143bc35820fa6f6df0ebbf9d6615f1e5369052e66c870 |