Empezar a contribuir con código a Weblate

Para entender el código fuente de Weblate, explore Código fuente de Weblate, Interfaz de Weblate y Weblate por dentro.

Primeros pasos con el código

Familiarize yourself with the Weblate codebase, by having a go at the bugs labelled good first issue.

You are welcome to start working on these issues without asking. Just announce that in the issue, so that it’s clear that somebody is working on that issue.

Ejecutar Weblate localmente

The most comfortable approach to get started with Weblate development is to follow Instalar desde el código fuente. It will get you a virtualenv with editable Weblate sources.

1. Clone el código fuente de Weblate:

   git clone https://github.com/WeblateOrg/weblate.git
   cd weblate
   

2. Cree un entorno virtual:

   uv venv .venv
   source .venv/bin/activate
   

3. Install Weblate (for this you need some system dependencies, see Instalar desde el código fuente) and all dependencies useful for development:

   uv pip install -e '.[dev]'
   

3. Inicie un servidor de desarrollo:

   weblate runserver
   

4. Depending on your configuration, you might also want to start Celery workers:

   ./weblate/examples/celery start
   

5. To run a test (see Puesta a prueba local for more details):

   . scripts/test-database.sh
   pytest
   

Ver también

Instalar desde el código fuente

Ejecutar Weblate localmente en Docker

If you have Docker and the docker-compose-plugin installed, you need an additional tool called jq which you can install through your favorite package manager. Then, you can spin up the development environment by simply running:

./rundev.sh

It will create a development Docker image and start it. Weblate is running on <http://127.0.0.1:8080/> and you can sign in as the user admin using admin as the password. The new installation is empty, so you might want to continue with Añadir proyectos y componentes de traducción.

The Dockerfile and docker-compose.yml for this are located in the dev-docker directory. For easier access to the database during development, the container running PostgreSQL is exposed on port 5433.

The script also accepts some parameters, to execute tests, run it with the test parameter and then specify any test parameters, for example running only tests in the weblate.machine module:

./rundev.sh test --exitfirst weblate/machine

Nota

Be careful that your Docker containers are up and running before running the tests. You can check that by running the docker ps command.

Para mostrar los registros:

./rundev.sh logs

Para detener los contenedores en segundo plano, ejecute:

./rundev.sh stop

Ejecutar la secuencia de órdenes sin argumentos recreará el contenedor de Docker y lo reiniciará.

Advertencia

Este contenedor no es adecuado para su uso en producción. Se sacrifica la seguridad para facilitar el desarrollo.

Arranque de su instancia de desarrollo

Es posible que desees utilizar import_demo para crear traducciones de demostración y createadmin para crear un usuario administrador.

Trabajar en Weblate con PyCharm

PyCharm es un conocido EID para Python. A continuación le ofrecemos algunas recomendaciones para configurar Weblate en este programa.

Considering you have just cloned the GitHub repository to a folder, just open it with PyCharm. Once the IDE is open, the first step is to specify the interpreter you want to use:

You can either choose to let PyCharm create the virtualenv for you, or select an already existing one:

Don’t forget to install the dependencies once the interpreter is set: Either through the console (the console from the IDE will directly use your virtualenv by default), or through the interface when you get a warning about missing dependencies.

The second step is to set the right info to use Django natively inside PyCharm: The idea is to be able to immediately trigger the unit tests in the IDE. For that you need to specify the root path of the Django project and the path to its settings:

Be careful, the Django project root is the actual root of the repository, not the Weblate sub-directory. About the settings, you could use the weblate/settings_test.py from the repository, but you could create your own setting and set it there.

The last step is to run the server and to put breakpoints in the code to be able to debug it. This is done by creating a new Django Server configuration:

Consejo

Tenga cuidado con la propiedad llamada Sin recarga: Evita que el servidor se recargue en vivo si modificas archivos. Esto permite que los puntos de interrupción del depurador persistan, cuando normalmente se descartarían al recargar el servidor.