Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/marrow/web.locale

A GILT (globalization, internationalization, localization, translation) support library for WebCore.
https://github.com/marrow/web.locale

Last synced: 7 days ago
JSON representation

A GILT (globalization, internationalization, localization, translation) support library for WebCore.

Host: GitHub
URL: https://github.com/marrow/web.locale
Owner: marrow
License: mit
Created: 2016-04-28T16:34:55.000Z (over 8 years ago)
Default Branch: develop
Last Pushed: 2019-05-23T22:03:30.000Z (over 5 years ago)
Last Synced: 2024-11-12T01:28:37.542Z (2 months ago)
Language: Python
Size: 18.6 KB
Stars: 0
Watchers: 3
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.rst
- License: LICENSE.txt

Awesome Lists containing this project

README

====================
WebCore GILT Support
====================

https://github.com/marrow/web.locale

What is GILT?
=============

GILT is an acronym representing the following aspects of your application:

- Globalization ("g11n", sometimes referred to as "regionalization")
- Internationalization ("i18n")
- Localization ("l10n")
- Translation.

The overall goal is that applications are written in such a way that they are translatable into different languages,
able to utilize location-aware formatting (numers, dates), are sensitive to individual cultural differences, physical
location (time zone), currency formats, etc.

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

Installing ``web.locale`` is easy, just execute the following in a terminal::

pip install web.locale

**Note:** We *strongly* recommend always using a container, virtualization, or sandboxing environment of some kind when
developing using Python; installing things system-wide is yucky (for a variety of reasons) nine times out of ten. We
prefer light-weight `virtualenv `_, others prefer solutions as
robust as `Vagrant `_.

If you add ``web.locale`` to the ``install_requires`` argument of the call to ``setup()`` in your application's
``setup.py`` file, this package will be automatically installed and made available when your own application or
library is installed. We recommend using "less than" version numbers to ensure there are no unintentional
side-effects when updating. Use ``web.locale<2.1`` to get all bugfixes for the current release, and
``web.locale<3.0`` to get bugfixes and feature updates while ensuring that large breaking changes are not installed.

Dependencies and Extras
-----------------------

This library glues together many support libraries from the community in order to provide a complete and robust GILT
support interface for WebCore (and other web framework) applications. Some of these dependencies are entirely optional
and can be installed by supplying ``setup.py`` (or ``pip``) with declared "extras". For example, to install a default
set of development-time dependencies and explciitly declare the catalog format you will be using, you might run:

pip install web.locale[development,json]

The available general extras are:

- ``development`` -- this installs a recommended set of development-time packages, including
`pytest `_ and a suite of plugins for it.

Message catalog format extras:

- ``po`` -- Install any extra libraries needed for GNU ``gettext`` message catalogs.

- ``json`` -- Install any extra libraries needed to load JSON-formatted message catalogs.

- ``yaml`` -- Install any extra libraries needed to load YAML-formatted message catalogs.

Development Version
-------------------

Development takes place on `GitHub `_ in the
`web.locale `_ project. Issue tracking, documentation, and downloads
are provided there. Development chat (both development of WebCore components and chat for users using WebCore to
develop their own solutions) is graciously provided by `Freenode `_ in the
``#webcore`` channel.

Installing the current development version requires `Git `_, a distributed source code management
system. If you have Git you can run the following to download and *link* the development version into your Python
runtime::

git clone https://github.com/marrow/web.locale.git
pip install -e web.locale

You can then upgrade to the latest version at any time::

(cd web.locale; git pull; pip install -e .)

Extra dependenies can be declared the same as per online installation::

pip install -e web.locale[development]

If you would like to make changes and contribute them back to the project, fork the GitHub project, make your changes,
and submit a pull request. This process is beyond the scope of this documentation; for more information see
`GitHub's documentation `_.

License
=======

The WebCore GILT support library (``web.locale``) has been released under the MIT Open Source license.

The MIT License
---------------

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
documentation files (the “Software”), to deal in the Software without restriction, including without limitation the
rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit
persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

.. |ghwatch| image:: https://img.shields.io/github/watchers/marrow/web.locale.svg?style=social&label=Watch
:target: https://github.com/marrow/web.locale/subscription
:alt: Subscribe to project activity on Github.

.. |ghstar| image:: https://img.shields.io/github/stars/marrow/web.locale.svg?style=social&label=Star
:target: https://github.com/marrow/web.locale/subscription
:alt: Star this project on Github.

.. |ghfork| image:: https://img.shields.io/github/forks/marrow/web.locale.svg?style=social&label=Fork
:target: https://github.com/marrow/web.locale/fork
:alt: Fork this project on Github.

.. |masterstatus| image:: http://img.shields.io/travis/marrow/web.locale/master.svg?style=flat
:target: https://travis-ci.org/marrow/web.locale/branches
:alt: Release build status.

.. |mastercover| image:: http://img.shields.io/codecov/c/github/marrow/web.locale/master.svg?style=flat
:target: https://codecov.io/github/marrow/web.locale?branch=master
:alt: Release test coverage.

.. |masterreq| image:: https://img.shields.io/requires/github/marrow/web.locale.svg
:target: https://requires.io/github/marrow/web.locale/requirements/?branch=master
:alt: Status of release dependencies.

.. |developstatus| image:: http://img.shields.io/travis/marrow/web.locale/develop.svg?style=flat
:target: https://travis-ci.org/marrow/web.locale/branches
:alt: Development build status.

.. |developcover| image:: http://img.shields.io/codecov/c/github/marrow/web.locale/develop.svg?style=flat
:target: https://codecov.io/github/marrow/web.locale?branch=develop
:alt: Development test coverage.

.. |developreq| image:: https://img.shields.io/requires/github/marrow/web.locale.svg
:target: https://requires.io/github/marrow/web.locale/requirements/?branch=develop
:alt: Status of development dependencies.

.. |issuecount| image:: http://img.shields.io/github/issues-raw/marrow/web.locale.svg?style=flat
:target: https://github.com/marrow/web.locale/issues
:alt: Github Issues

.. |ghsince| image:: https://img.shields.io/github/commits-since/marrow/web.locale/2.0.0.svg
:target: https://github.com/marrow/web.locale/commits/develop
:alt: Changes since last release.

.. |ghtag| image:: https://img.shields.io/github/tag/marrow/web.locale.svg
:target: https://github.com/marrow/web.locale/tree/2.0.0
:alt: Latest Github tagged release.

.. |latestversion| image:: http://img.shields.io/pypi/v/web.locale.svg?style=flat
:target: https://pypi.python.org/pypi/web.locale
:alt: Latest released version.

.. |downloads| image:: http://img.shields.io/pypi/dw/web.locale.svg?style=flat
:target: https://pypi.python.org/pypi/web.locale
:alt: Downloads per week.

.. |cake| image:: http://img.shields.io/badge/cake-lie-1b87fb.svg?style=flat