Metadata-Version: 2.4
Name: git-archive-all
Version: 1.24.0
Summary: Archive git repository with its submodules.
Home-page: https://github.com/Kentzo/git-archive-all
Author: Ilya Kulakov
Author-email: kulakov.ilya@gmail.com
License-Expression: MIT
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: System Administrators
Classifier: Natural Language :: English
Classifier: Operating System :: MacOS
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Programming Language :: Python :: 3.15
Classifier: Topic :: Software Development :: Version Control
Classifier: Topic :: System :: Archiving
Classifier: Typing :: Typed
Requires-Python: !=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,!=3.4.*,>=2.7
Description-Content-Type: text/x-rst
License-File: LICENSE.txt
Dynamic: license-file
Dynamic: license-expression

| |pypi| |homebrew|
| |implementations| |versions|
| |ci| |coverage|

.. |pypi| image:: https://img.shields.io/pypi/v/git-archive-all.svg
    :target: https://pypi.org/project/git-archive-all/
    :alt: PyPI
.. |homebrew| image:: https://img.shields.io/homebrew/v/git-archive-all.svg
    :target: https://formulae.brew.sh/formula/git-archive-all
    :alt: Homebrew
.. |versions| image:: https://img.shields.io/pypi/pyversions/git-archive-all.svg
    :target: https://pypi.org/project/git-archive-all/
    :alt: Supported Python versions
.. |implementations| image:: https://img.shields.io/pypi/implementation/git-archive-all.svg
    :target: https://pypi.org/project/git-archive-all/
    :alt: Supported Python implementations
.. |ci| image:: https://github.com/Kentzo/git-archive-all/actions/workflows/ci.yml/badge.svg?branch=1.x
    :target: https://github.com/Kentzo/git-archive-all/actions/workflows/ci.yml?query=branch%3A1.x
    :alt: CI
.. |coverage| image:: https://codecov.io/gh/Kentzo/git-archive-all/branch/1.x/graph/badge.svg
    :target: https://codecov.io/gh/Kentzo/git-archive-all/branch/1.x
    :alt: Coverage

Archive a repository with all its submodules.

::

    git-archive-all [-v] [-C BASE_REPO] [--prefix PREFIX] [--no-export-ignore] [--force-submodules] [--include EXTRA1 ...] [--dry-run] [-0 | ... | -9] OUTPUT_FILE

    Options:

      --version             show program's version number and exit

      -h, --help            show this help message and exit

      -v, --verbose         enable verbose mode

      --prefix=PREFIX       prepend PREFIX to each filename in the archive;
                            defaults to OUTPUT_FILE name

      -C BASE_REPO          use BASE_REPO as the main git repository to archive;
                            defaults to the current directory when empty

      --no-export-ignore    ignore the [-]export-ignore attribute in .gitattributes

      --force-submodules    force `git submodule init && git submodule update` at
                            each level before iterating submodules

      --include=EXTRA       additional files to include in the archive

      --dry-run             show files to be archived without actually creating the archive

Questions & Answers
-------------------

| Q: How to exclude files?
| A: Mark paths you want to exclude in the .gitattributes file with the export-ignore attribute. Read more on `git-scm.com <https://git-scm.com/docs/gitattributes#_code_export_ignore_code>`_.

| Q: What about non-unicode filenames?
| A: All filenames that particular version of Python can represent and handle are supported. Extra [en|de]coding is done where appropriate.

Support
-------
If functional you need is missing but you're ready to pay for it, feel free to `contact me <mailto:kulakov.ilya@gmail.com?subject=git-archive-all>`_. If not, create an issue anyway, I'll take a look as soon as I can.
