Welcome to django_languageselect’s documentation!¶

Contents:

Installation¶

Stable release¶

To install django_languageselect, run this command in your terminal:

$ pip install django_languageselect

This is the preferred method to install django_languageselect, as it will always install the most recent stable release.

If you don’t have pip installed, this Python installation guide can guide you through the process.

From sources¶

The sources for django_languageselect can be downloaded from the Github repo.

You can either clone the public repository:

$ git clone git://github.com/RegioHelden GmbH/django_languageselect

Or download the tarball:

$ curl  -OL https://github.com/RegioHelden GmbH/django_languageselect/tarball/master

Once you have a copy of the source, you can install it with:

$ python setup.py install

Usage¶

To use django_languageselect in a project, add it to INSTALLED_APP

‘django_languageselect’,

Add this to your urls.py

url(r’^languageselect/’, include(‘django_languageselect.urls’)),

Use the languageselect tag where you which to show languages list:

{% load languageselect %} {% languageselect %}

Contributing¶

Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.

You can contribute in many ways:

Types of Contributions¶

Report Bugs¶

Report bugs at https://github.com/RegioHelden/django-languageselect/issues.

If you are reporting a bug, please include:

Your operating system name and version.
Any details about your local setup that might be helpful in troubleshooting.
Detailed steps to reproduce the bug.

Fix Bugs¶

Look through the GitHub issues for bugs. Anything tagged with “bug” and “help wanted” is open to whoever wants to implement it.

Implement Features¶

Look through the GitHub issues for features. Anything tagged with “enhancement” and “help wanted” is open to whoever wants to implement it.

Write Documentation¶

django_languageselect could always use more documentation, whether as part of the official django_languageselect docs, in docstrings, or even on the web in blog posts, articles, and such.

Submit Feedback¶

The best way to send feedback is to file an issue at https://github.com/RegioHelden/django-languageselect/issues.

If you are proposing a feature:

Explain in detail how it would work.
Keep the scope as narrow as possible, to make it easier to implement.
Remember that this is a volunteer-driven project, and that contributions are welcome :)

Get Started!¶

Ready to contribute? Here’s how to set up django_languageselect for local development.

Fork the django_languageselect repo on GitHub.

Clone your fork locally:

$ git clone git@github.com:your_name_here/django_languageselect.git

Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development:
```
$ mkvirtualenv django_languageselect
$ cd django_languageselect/
$ python setup.py develop
```
Create a branch for local development:
```
$ git checkout -b name-of-your-bugfix-or-feature
```
Now you can make your changes locally.
When you’re done making changes, check that your changes pass flake8 and the tests, including testing other Python versions with tox:
```
$ flake8 django_languageselect tests
$ python setup.py test or py.test
$ tox
```
To get flake8 and tox, just pip install them into your virtualenv.

Commit your changes and push your branch to GitHub:

$ git add .
$ git commit -m "Your detailed description of your changes."
$ git push origin name-of-your-bugfix-or-feature

Submit a pull request through the GitHub website.

Pull Request Guidelines¶

Before you submit a pull request, check that it meets these guidelines:

The pull request should include tests.
If the pull request adds functionality, the docs should be updated. Put your new functionality into a function with a docstring, and add the feature to the list in README.rst.
The pull request should work for Python 2.7, 3.6, 3.7 and for PyPy. Check https://travis-ci.org/RegioHelden/django-languageselect/pull_requests and make sure that the tests pass for all supported Python versions.

Tips¶

To run a subset of tests:

$ python -m unittest tests.test_django_languageselect

Credits¶

Development Lead¶

Jens Nistler <jens.nistler@regiohelden.de>
Mounir Messelmeni <mounir.messelmeni@regiohelden.de>

Contributors¶

None yet. Why not be the first?

History¶

Unreleased¶

Remove support for Python < 3.9
Remove support for Django 4.0
Modernize build and test environment

4.0.1 (2023-01-02)¶

Remove support for Django < 3.2
Remove support for Python < 3.8
Modernize build and test environment

4.0.0 (2023-01-02)¶

Not released to due an issue with the deploy action

3.0.0 (2021-05-05)¶

Remove support for Django 2.x
Remove utf 8 headers as all Python 3 files must be unicode anyways
Fix CI badge in readme
Modernize build and test environment

2.0.2 (2021-05-05)¶

Remove setting language in session as this was depreacted since Django 2.x and is broken with Django 3.x
Add tests for Django 3.2
Remove old python 2 and Django compatibility code

2.0.1 (2021-03-25)¶

Fix documentation syntax

2.0.0 (2021-03-25)¶

Update packages
Update Docker env
Remove support for Django < 2.2

1.0.0 (2019-11-04)¶

Update packages
Remove Python 2 support
Add docker container to run tests locally

0.1.6 (2018-01-27)¶

Add missing folders and modules from package

0.1.5 (2018-01-15)¶

Add support for python 3 and Django 2, impleneting tests in travis ci

0.1.4 (2017-04-18)¶

Rename package to django_languageselect (backwards incompatible) to be able to import the module

0.1.3 (2016-06-17)¶

Fix session key to store language, Django 1.9 compatibility