https://github.com/m-xim/fluentus

Fluentus is a powerful tool designed to edit the Fluent localization files from Project Fluent
https://github.com/m-xim/fluentus

ftl internationalization localization localization-tool project-fluent

Last synced: 5 months ago
JSON representation

Fluentus is a powerful tool designed to edit the Fluent localization files from Project Fluent

• Host: GitHub
• URL: https://github.com/m-xim/fluentus
• Owner: m-xim
• License: gpl-3.0
• Created: 2024-12-08T01:57:16.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2025-09-16T04:36:22.000Z (9 months ago)
• Last Synced: 2025-09-16T06:28:47.146Z (9 months ago)
• Topics: ftl, internationalization, localization, localization-tool, project-fluent
• Language: Python
• Homepage:
• Size: 959 KB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# fluentus

[![GitHub release (latest by date)](https://img.shields.io/github/v/release/m-xim/fluentus)](https://github.com/m-xim/fluentus/releases/latest)

[![Deployment Status](https://img.shields.io/github/actions/workflow/status/m-xim/fluentus/release.yml?branch=main&label=build%20main)](https://github.com/m-xim/fluentus/actions)

[![Deployment Status](https://img.shields.io/github/actions/workflow/status/m-xim/fluentus/release.yml?branch=dev&label=build%20dev)](https://github.com/m-xim/fluentus/actions)

[![GitHub License](https://img.shields.io/github/license/m-xim/fluentus)](https://github.com/m-xim/fluentus/blob/main/LICENSE)

[![Supported Syntax Version](https://img.shields.io/badge/Syntax%20Version-Fluent%20v1.0-blue?logo=)](https://projectfluent.org/)

[//]: # (## About)

Fluentus is a powerful tool designed to edit the Fluent localization files from [Project Fluent](https://projectfluent.org)

> [!WARNING]

> Fluentus is currently in beta stage. Please proceed with caution and ensure to back up your localization files before using Fluentus.



## Usage

To run the project, download the latest release from the [Releases](https://github.com/m-xim/fluentus/releases) page. Choose the version for your platform (Windows, macOS, Linux) and run the downloaded file.

Run from source

To run the project from source, follow these steps:

1. Clone the repository: `git clone https://github.com/m-xim/fluentus.git`

2. Navigate to the project directory: `cd fluentus`

3. Install the dependencies: `pip install -r requirements.txt`

4. Run the project: `python src/app.py`

## Localization Files Structure

The localization files are organized into language-specific directories. Each directory contains Fluent Translation List (FTL) files and subdirectories as needed.

```plaintext

locales/

├── en/       # English localization files

│   ├── example.ftl

│   └── subfolder/

│       └── another_example.ftl

├── ru/       # Russian localization files

│   ├── example.ftl

│   └── subfolder/

│       └── another_example.ftl

└── ...       # Other language

```

> [!TIP]

> Download the `example_locales` folder from the repository. This folder contains the localization files that you can use to test and understand how Fluentus works.

## Contributing

We welcome contributions! To contribute:

1. Fork the repository.

2. Create a new branch: 

   `git checkout -b feature/your-feature-name`

3. Make your changes and submit a pull request.

## Development

Building

To building the project, follow these steps:

1. Clone the repository: `git clone https://github.com/m-xim/fluentus.git`

2. Navigate to the project directory: `cd fluentus`

3. Create a virtual environment `python -m venv venv`

4. Activate the virtual environment:

   * Windows: `venv\Scripts\activate`  

   * Linux, macOS: `source venv/bin/activate`

5. Install the dependencies: `pip install -r requirements.txt`

6. Building the project: `python src/app.py`

   * Main Version: `pyinstaller main.spec`

   * Debug Version: `pyinstaller dev.spec`