https://github.com/dlrsp/django-lang

Django application to provide useful utils and reusable parts of code for multi-languages sites.
https://github.com/dlrsp/django-lang

Last synced: about 1 year ago
JSON representation

Django application to provide useful utils and reusable parts of code for multi-languages sites.

• Host: GitHub
• URL: https://github.com/dlrsp/django-lang
• Owner: DLRSP
• License: mit
• Created: 2023-10-21T21:12:07.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-10-09T01:49:51.000Z (over 1 year ago)
• Last Synced: 2024-11-10T10:06:09.100Z (over 1 year ago)
• Language: Python
• Homepage:
• Size: 398 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: .github/CODE_OF_CONDUCT.md
  • Codeowners: CODEOWNERS
  • Security: .github/SECURITY.md

Awesome Lists containing this project

README

          
# django-lang [![PyPi license](https://img.shields.io/pypi/l/django-lang.svg)](https://pypi.python.org/pypi/django-lang)

[![PyPi status](https://img.shields.io/pypi/status/django-lang.svg)](https://pypi.python.org/pypi/django-lang)

[![PyPi version](https://img.shields.io/pypi/v/django-lang.svg)](https://pypi.python.org/pypi/django-lang)

[![PyPi python version](https://img.shields.io/pypi/pyversions/django-lang.svg)](https://pypi.python.org/pypi/django-lang)

[![PyPi downloads](https://img.shields.io/pypi/dm/django-lang.svg)](https://pypi.python.org/pypi/django-lang)

[![PyPi downloads](https://img.shields.io/pypi/dw/django-lang.svg)](https://pypi.python.org/pypi/django-lang)

[![PyPi downloads](https://img.shields.io/pypi/dd/django-lang.svg)](https://pypi.python.org/pypi/django-lang)

## GitHub ![GitHub release](https://img.shields.io/github/tag/DLRSP/django-lang.svg) ![GitHub release](https://img.shields.io/github/release/DLRSP/django-lang.svg)

## Test [![codecov.io](https://codecov.io/github/DLRSP/django-lang/coverage.svg?branch=main)](https://codecov.io/github/DLRSP/django-lang?branch=main) [![pre-commit.ci status](https://results.pre-commit.ci/badge/github/DLRSP/django-lang/main.svg)](https://results.pre-commit.ci/latest/github/DLRSP/django-lang/main) [![gitthub.com](https://github.com/DLRSP/django-lang/actions/workflows/ci.yaml/badge.svg)](https://github.com/DLRSP/django-lang/actions/workflows/ci.yaml)

## Check Demo Project

* Check the demo repo on [GitHub](https://github.com/DLRSP/example/tree/django-lang)

## Requirements

-   Python 3.8+ supported.

-   Django 3.2+ supported.

## Setup

1. Install from **pip**:

    ```shell

    pip install django-lang

    ```

2. Modify `settings.py` by adding the app to `INSTALLED_APPS`:

    ```python

    INSTALLED_APPS = [

        # ...

        "lang",

        # ...

    ]

    ```

3. Modify `settings.py` by adding the app to `INSTALLED_APPS`:

    ``` python title="settings.py" hl_lines="12"

    TEMPLATES = [

        {

            "BACKEND": "django.template.backends.django.DjangoTemplates",

            "DIRS": [os.path.join(PROJECT_DIR, "templates")],

            "APP_DIRS": True,

            "OPTIONS": {

                "context_processors": [

                    "django.template.context_processors.debug",

                    "django.template.context_processors.request",

                    "django.contrib.auth.context_processors.auth",

                    "django.contrib.messages.context_processors.messages",

                    "lang.context_processors.from_settings",

                ],

            },

        },

    ]

    ```

4. Modify your project's base template `base.html` to include language's switcher styles:

    ```html

    

        ...

        

        ...

    

    ```

5. Modify your project's base template `base.html` to include attributes using `translate_url` template's tag:

    ```html

    

        ...

        

        {% include "hreflang.html" %}

        ...

    

    ```

6. Modify your project's nav template `nav.html` to include language's switcher:

    ```html

    

        ...

        


            {% include "nav-link.html" %}

        

        ...

    

    ```


## Run Example Project

```shell

git clone --depth=50 --branch=django-lang https://github.com/DLRSP/example.git DLRSP/example

cd DLRSP/example

python manage.py runserver

```

Now browser the app @ http://127.0.0.1:8000

## References

- [brainstorm.it](https://brainstorm.it/snippets/django-language-switching/) - Language's switching

- [hakibenita.com](https://hakibenita.com/django-multi-language-site-hreflang) - Url's translation for "hreflang" html's attributes