From 17b915e13eaae6454e11ee68b90843ac6f9fbed2 Mon Sep 17 00:00:00 2001 From: Ralph Broenink Date: Mon, 1 Dec 2014 18:50:00 +0100 Subject: [PATCH] Update some project files --- CONTRIBUTING.rst | 33 +++++++++++++++++++++++++++++++++ README.rst | 36 +++--------------------------------- setup.cfg | 5 +++++ setup.py | 25 +++++++++++++++++++++++-- 4 files changed, 64 insertions(+), 35 deletions(-) create mode 100644 CONTRIBUTING.rst create mode 100644 setup.cfg diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst new file mode 100644 index 0000000..221749e --- /dev/null +++ b/CONTRIBUTING.rst @@ -0,0 +1,33 @@ +========================================== +Contributing to django-internationalflavor +========================================== +If you'd like to contribute, please follow these steps: + +Tests +===== +There are no tests yet. Sorry! + +Common Locale Data Repository +============================= +The folder ``scripts`` contains some useful scripts to update the repository data according to the CLDR. To update +all data, use:: + + scripts/datafromcldr.py cldr.zip + +This will generate (or update) two types of files: all ``_cldr_data.py`` files, with dicts containing translatable +strings, and ``cldr.po`` files, that contain the translations of all CLDR strings. You can merge these into the +Django translation files using:: + + scripts/mergemessages.py + +This command will also synchronize with a file named ``django_only.po``, which can be used by translators to translate +messages (instead of the huge ``django.po`` file that also contains CLDR strings). + +The repository should only contain a compiled ``django.mo`` file, the ``cldr.po`` and ``django_only.po`` files don't +need to be compiled. + +Always run ``mergemessages.py`` after running ``django-admin makemessages``. + +Translators should note that all CLDR data will be automatically overwritten with translations. If any modification is +required, a translation should be made in the ``django.po`` file (as ``cldr.po`` is always overwritten) and marked +with a comment containing the text ``manual``. However, please submit corrected translations always to the CLDR. diff --git a/README.rst b/README.rst index 3ac0de7..83acdd7 100644 --- a/README.rst +++ b/README.rst @@ -1,12 +1,14 @@ django-internationalflavor ========================== -:mod:`django-internationalflavor` is born to complement the :mod:`django-localflavor` package. While localflavor is +``django-internationalflavor`` is born to complement the ``django-localflavor`` package. While localflavor is awesome when you are making a localized app, the reality is that you often need to accommodate for users from multiple countries. While Django has great support for internationalization and localization, there is no package that helps you store data from all over the world. This package aims to fill the gap and provides fields that are designed for use in almost every country, while enforcing consistent data types. +Please note, this package is still in development. Most importantly, it lacks tests. + Documentation ------------- The documentation of this project is available at http://django-internationalflavor.readthedocs.org/en/latest/ @@ -18,35 +20,3 @@ Installation pip install django-internationalflavor -Contributing ------------- -If you'd like to contribute, please follow these steps: - -Tests -~~~~~ -There are no tests yet. Sorry! - -Common Locale Data Repository -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -The folder ``scripts`` contains some useful scripts to update the repository data according to the CLDR. To update -all data, use:: - - scripts/datafromcldr.py cldr.zip - -This will generate (or update) two types of files: all ``_cldr_data.py`` files, with dicts containing translatable -strings, and ``cldr.po`` files, that contain the translations of all CLDR strings. You can merge these into the -Django translation files using:: - - scripts/mergemessages.py - -This command will also synchronize with a file named ``django_only.po``, which can be used by translators to translate -messages (instead of the huge ``django.po`` file that also contains CLDR strings). - -The repository should only contain a compiled ``django.mo`` file, the ``cldr.po`` and ``django_only.po`` files don't -need to be compiled. - -Always run ``mergemessages.py`` after running ``django-admin makemessages``. - -Translators should note that all CLDR data will be automatically overwritten with translations. If any modification is -required, a translation should be made in the ``django.po`` file (as ``cldr.po`` is always overwritten) and marked -with a comment containing the text ``manual``. However, please submit corrected translations always to the CLDR. diff --git a/setup.cfg b/setup.cfg new file mode 100644 index 0000000..1715a03 --- /dev/null +++ b/setup.cfg @@ -0,0 +1,5 @@ +[metadata] +license-file = LICENSE + +[wheel] +universal = 1 \ No newline at end of file diff --git a/setup.py b/setup.py index 34653f6..3495a43 100644 --- a/setup.py +++ b/setup.py @@ -102,14 +102,35 @@ def find_package_data(where='.', package='', return out +version = find_version("internationalflavor", "__init__.py") + setup( name='django-internationalflavor', - version=find_version("internationalflavor", "__init__.py"), + version=version, packages=find_packages(exclude=['tests', 'tests.*']), package_data=find_package_data(), url='https://github.com/ralphje/django-internationalflavor', + download_url='https://github.com/ralphje/django-internationalflavor/tarball/' + version, license='MIT', author='Ralph Broenink', author_email='ralph@ralphbroenink.net', - description='Complementing django-localflavor with fields that are applicable to multiple countries' + description='Complementing django-localflavor with fields that are applicable to multiple countries', + classifiers=[ + 'Development Status :: 3 - Alpha', + 'Environment :: Web Environment', + 'Framework :: Django', + 'Intended Audience :: Developers', + 'License :: OSI Approved :: MIT License', + 'Operating System :: OS Independent', + 'Programming Language :: Python', + 'Programming Language :: Python :: 2', + 'Programming Language :: Python :: 2.6', + 'Programming Language :: Python :: 2.7', + 'Programming Language :: Python :: 3', + 'Programming Language :: Python :: 3.2', + 'Programming Language :: Python :: 3.3', + 'Programming Language :: Python :: 3.4', + 'Topic :: Internet :: WWW/HTTP', + ], + zip_safe=False, )