<commit_before>==============
jarn.mkrelease
==============
---------------------------------------------------
Python egg releaser
---------------------------------------------------

**mkrelease** is a no-frills Python egg releaser. It is designed to take
the cumber out of building and distributing Python eggs.

Also see `jarn.viewdoc`_.

.. _`jarn.viewdoc`: https://pypi.python.org/pypi/jarn.viewdoc

Motivation
==========

Python eggs are great, and we strive to release all software in egg form.
However, as projects grow larger and are comprised of more and more eggs,
release requirements can become a burden.

This is because it takes some work to put a new egg on a
distribution server. After preparing a package for release (update
version strings, etc.), we typically have to:

1. Commit modified files.

2. Tag the release.

3. Package up an egg.

4. Distribute the egg via scp or upload it to an index server.

Now imagine doing this a lot, and the need for automation becomes
obvious.

Installation
============

mkrelease works with Python 2.6 - 3.6 and all released versions of setuptools
and distribute.

Use ``easy_install jarn.mkrelease`` to install the ``mkrelease`` script.
Then put it on your system PATH by e.g. symlinking it to ``/usr/local/bin``.

Usage
=====

``mkrelease [options] [scm-url [rev]|scm-sandbox]``

Options
=======

``-C, --no-commit``
    Do not commit modified files from the sandbox.

``-T, --no-tag``
    Do not tag the release in SCM.

``-R, --no-register``
    Do not register the release with dist-location.

``-S, --no-upload``
    Do not upload the release to dist-location.

``-n, --dry-run``
    Dry-run; equivalent to ``-CTS``.

``--svn, --hg, --git``
    Select the SCM type. Only required if the SCM type
    cannot be guessed from the argument.

``-d dist-location, --dist-location=dist-location``
    An scp or sftp destination specification, an index
    server configured in ``~/.pypirc``, or an alias name for
    either. This option may be specified more than once.

``-s, --sign``
    Sign the release with GnuPG.<commit_msg>Update README.<commit_after>==============
jarn.mkrelease
==============
---------------------------------------------------
Python egg releaser
---------------------------------------------------

**mkrelease** is a no-frills Python egg releaser. It is designed to take
the cumber out of building and distributing Python eggs.

Also see `jarn.viewdoc`_.

.. _`jarn.viewdoc`: https://pypi.python.org/pypi/jarn.viewdoc

Motivation
==========

Python eggs are great, and we strive to release all software in egg form.
However, as projects grow larger and are comprised of more and more eggs,
release requirements can become a burden.

This is because it takes some work to put a new egg on a
distribution server. After preparing a package for release (update
version strings, etc.), we typically have to:

1. Commit modified files.

2. Tag the release.

3. Package up an egg.

4. Distribute the egg via scp or upload it to an index server.

Now imagine doing this a lot, and the need for automation becomes
obvious.

Installation
============

mkrelease works with Python 2.6 - 3.6 and all released versions of setuptools
and distribute.

Use ``easy_install jarn.mkrelease`` to install the ``mkrelease`` script.
Then put it on your system PATH by e.g. symlinking it to ``/usr/local/bin``.

Usage
=====

``mkrelease [options] [scm-url [rev]|scm-sandbox]``

Options
=======

``-C, --no-commit``
    Do not commit modified files from the sandbox.

``-T, --no-tag``
    Do not tag the release in SCM.

``-R, --no-register``
    Do not register the release with dist-location.

``-S, --no-upload``
    Do not upload the release to dist-location.

``-n, --dry-run``
    Dry-run; equivalent to ``-CTRS``.

``--svn, --hg, --git``
    Select the SCM type. Only required if the SCM type
    cannot be guessed from the argument.

``-d dist-location, --dist-location=dist-location``
    An scp or sftp destination specification, an index
    server configured in ``~/.pypirc``, or an alias name for
    either. This option may be specified more than once.

``-s, --sign``
    Sign the release with GnuPG.
{'fraction_non_alphanumeric': 0.17113451412158928, 'fraction_numerical': 0.003829583532790809, 'mean_word_length': 2.8094804010938925, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 2, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '1908282', 'n_tokens_mistral': 1256, 'n_tokens_neox': 1200, 'n_words': 550}