view RELEASE.txt @ 5525:bb7865241f8a

Make CSV import/export compatible across Python versions (also RDBMS journals) (issue 2550976, issue 2550975). The roundup-admin export and import commands are used for migrating between different database backends. It is desirable that they should be usable also for migrations between Python 2 and Python 3, and in some cases (e.g. with the anydbm backend) this may be required. To be usable for such migrations, the format of the generated CSV files needs to be stable, meaning the same as currently used with Python 2. The export process uses repr() to produce the fields in the CSV files and eval() to convert them back to Python data structures. repr() of strings with non-ASCII characters produces different results for Python 2 and Python 3. This patch adds repr_export and eval_import functions to roundup/anypy/strings.py which provide the required operations that are just repr() and eval() in Python 2, but are more complicated in Python 3 to use data representations compatible with Python 2. These functions are then used in the required places for export and import. repr() and eval() are also used in storing the dict of changed values in the journal for the RDBMS backends. It is similarly desirable that the database be compatible between Python 2 and Python 3, so that export and import do not need to be used for a migration between Python versions for non-anydbm back ends. Thus, this patch changes rdbms_common.py in the places involved in storing journals in the database, not just in those involved in import/export. Given this patch, import/export with non-ASCII characters appear based on some limited testing to work across Python versions, and an instance using the sqlite backend appears to be compatible between Python versions without needing import/export, *if* the sessions/otks databases (which use anydbm) are deleted when changing Python version.
author Joseph Myers <jsm@polyomino.org.uk>
date Sun, 02 Sep 2018 23:48:04 +0000
parents 0036f4a7bf2a
children bff95a7bcdbc
line wrap: on
line source

Building Releases
=================

Roundup is a pure Python application with no binary components. This file
describes how to build a source release. To find out how to install
Roundup, read the doc/installation.txt file.

Roundup release checklist:

1.  Regenerate locale/roundup.pot.  See "Extracting Translatable
    Messages" in doc/developers.txt.  This is best done some time in
    advance of the release to allow for translators to update their
    translations.
2.  Run unit tests! They should pass successfully. "./run_tests.py"
3.  Update version
      CHANGES.txt
      roundup/__init__.py
      website/www/index.txt
      website/www/conf.py  (also update copyright)
3a. Update license end date in COPYING.txt
3b. Update doc/acknowledgements.txt (add section for
    release, churn contributers etc.).
4.  Update documentation
      doc/announcement.txt
      doc/upgrading.txt
4a. cd to website/www and run 'make linkcheck'. See output in
    _tmp/linkcheck/output.txt
       fix broken references in docs
       verify redirects are correct
5.  Update setup.py info is needed (contacts, classifiers, etc.), and
    check that metadata is valid and long descriptions is proper reST:
      python setup.py check --restructuredtext --metadata --strict
6.  Clean out all *.orig, *.rej, .#* files from the source.
7.  Remove previous build files
      python setup.py clean --all
8.  Rebuild documentation in "share/doc/roundup/html"
      python setup.py build_doc
9.  python setup.py sdist --manifest-only
10. Check the MANIFEST to make sure that any new files are included.
      (use hg status --rev <last release or tag>:tip to list changed
      added and removed files. Last release e.g. 1.5.1 where tip was
      what would become 1.6)
    If they are not, edit MANIFEST.in to include them. For format docs see
    http://docs.python.org/2/distutils/sourcedist.html#manifest-template
11. python setup.py sdist
    (if you find sdist a little verbose, add "--quiet" to the end of the
     command)
12. Unpack the new tarball created in dist/roundup-<version>.tar.gz
    file in /tmp then
      a) run_tests.py
      b) demo.py
    with all available Python versions.
13. Assuming all is well tag the release in the version-control
    system.
      a) hg tag 1.6.0  # use right version. Should create/commit a changeset
      b) hg push       # update main repo
      c) hg sum        # verify that the tag shows up
14. Upload source distributive to PyPI - requires you sign up for a
    pypi account and be added as a maintainer to roundup. Ask existing
    maintainer for access.
      python setup.py sdist upload --repository pypi --sign
    It should appear on http://pypi.python.org/pypi/roundup in no
    time. If you are using python older than 2.7.13 you need a
    .pypirc shown below. URL has changed. If using 2.7.13 or newer,
    you can remove the "--repository pypi" option.
15. Send doc/announcement.txt to python-announce@python.org and
    roundup-users@lists.sourceforge.net and
    roundup-devel@lists.sourceforge.net
16. Refresh website.
      website/README.txt
      http://www.roundup-tracker.org/ should state that the stable
      version is the one that you released.
      http://www.roundup-tracker.org/docs.html should also match the
      released version (or atleast the major 1.x release.

So, those commands in a nice, cut'n'pasteable form::

 find . -name '*.orig' -exec rm {} \;
 find . -name '*.rej' -exec rm {} \;
 find . -name '.#*' -exec rm {} \;
 python setup.py clean --all
 python setup.py check --restructuredtext --metadata --strict
 python setup.py build_doc
 python setup.py sdist --manifest-only
 python setup.py sdist --quiet
 python setup.py bdist_rpm
 # not required for pypi.org since 2017 -> python setup.py register
 python setup.py sdist upload --repository pypi --sign

Note pypi no longer allows uploads of .exe installers such as produced
by bdist_wininst. Removed directions for producing the binary
distribution.

If you get errors on the upload operation, you may need the following
~/.pypirc file as well

========
[distutils]
index-servers =
    test
    pypi

[pypi]
repository: https://upload.pypi.org/legacy/
username: <your username on pypi.org here>
password: <your password here>

[test]
repository: https://test.pypi.org/legacy/
username: <your username on test.pypi.org here>
password: <your password here>
========


Roundup Issue Tracker: http://roundup-tracker.org/