Skip to content

Commit

Permalink
Update some project files
Browse files Browse the repository at this point in the history
  • Loading branch information
ralphje committed Dec 1, 2014
1 parent 761fef3 commit 17b915e
Show file tree
Hide file tree
Showing 4 changed files with 64 additions and 35 deletions.
33 changes: 33 additions & 0 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
@@ -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.
36 changes: 3 additions & 33 deletions README.rst
Original file line number Diff line number Diff line change
@@ -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/
Expand All @@ -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.
5 changes: 5 additions & 0 deletions setup.cfg
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
[metadata]
license-file = LICENSE

[wheel]
universal = 1
25 changes: 23 additions & 2 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -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='[email protected]',
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,
)

0 comments on commit 17b915e

Please sign in to comment.