README.rst 2.8 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364
  1. | |pypi| |homebrew|
  2. | |implementations| |versions|
  3. | |travis| |coverage|
  4. .. |pypi| image:: https://img.shields.io/pypi/v/git-archive-all.svg
  5. :target: https://pypi.python.org/pypi/git-archive-all
  6. :alt: PyPI
  7. .. |homebrew| image:: https://img.shields.io/homebrew/v/git-archive-all.svg
  8. :target: https://formulae.brew.sh/formula/git-archive-all
  9. :alt: Homebrew
  10. .. |versions| image:: https://img.shields.io/pypi/pyversions/git-archive-all.svg
  11. :target: https://pypi.python.org/pypi/git-archive-all
  12. :alt: Supported Python versions
  13. .. |implementations| image:: https://img.shields.io/pypi/implementation/git-archive-all.svg
  14. :target: https://pypi.python.org/pypi/git-archive-all
  15. :alt: Supported Python implementations
  16. .. |travis| image:: https://travis-ci.org/Kentzo/git-archive-all.svg?branch=master
  17. :target: https://travis-ci.org/Kentzo/git-archive-all
  18. :alt: Travis
  19. .. |coverage| image:: https://codecov.io/gh/Kentzo/git-archive-all/branch/master/graph/badge.svg
  20. :target: https://codecov.io/gh/Kentzo/git-archive-all/branch/master
  21. :alt: Coverage
  22. Archive a repository with all its submodules.
  23. ::
  24. git-archive-all [-v] [-C BASE_REPO] [--prefix PREFIX] [--no-export-ignore] [--force-submodules] [--include EXTRA1 ...] [--dry-run] [-0 | ... | -9] OUTPUT_FILE
  25. Options:
  26. --version show program's version number and exit
  27. -h, --help show this help message and exit
  28. -v, --verbose enable verbose mode
  29. --prefix=PREFIX prepend PREFIX to each filename in the archive;
  30. defaults to OUTPUT_FILE name
  31. -C BASE_REPO use BASE_REPO as the main git repository to archive;
  32. defaults to the current directory when empty
  33. --no-export-ignore ignore the [-]export-ignore attribute in .gitattributes
  34. --force-submodules force `git submodule init && git submodule update` at
  35. each level before iterating submodules
  36. --include=EXTRA additional files to include in the archive
  37. --dry-run show files to be archived without actually creating the archive
  38. Questions & Answers
  39. -------------------
  40. | Q: How to exclude files?
  41. | 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>`_.
  42. | Q: What about non-unicode filenames?
  43. | A: All filenames that particular version of Python can represent and handle are supported. Extra [en|de]coding is done where appropriate.
  44. Support
  45. -------
  46. 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.