Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/cake-contrib/cake.transifex

Cake addin adding support for the Transifex Client
https://github.com/cake-contrib/cake.transifex

cake cake-addin cake-build hacktoberfest localization transifex

Last synced: 21 days ago
JSON representation

Cake addin adding support for the Transifex Client

Awesome Lists containing this project

README

        

# Cake.Transifex

[![All Contributors][all-contributorsimage]](#contributors)
[![license](https://img.shields.io/github/license/cake-contrib/Cake.Transifex.svg)](https://github.com/cake-contrib/Cake.Transifex/blob/master/LICENSE)
[![Open Source Helpers](https://www.codetriage.com/wormiecorp/cake.transifex/badges/users.svg)](https://www.codetriage.com/wormiecorp/cake.transifex)

Cake.Transifex is a addin for the Cake Build script adding support for working with the localization service Transifex.
This addin requires that the transifex client is already installed and is available as `tx`.

## Table of Contents

- [Information](#information)
- [Where to get the addin](#where-to-get-the-addin)
- [Usage](#usage)
- [Build Status](#build-status)
- [Code Coverage](#code-coverage)
- [Quick Links](#quick-links)
- [Chat Room](#chat-room)
- [Building Cake.Transifex](#building-caketransifex)
- [Contributors](#contributors)

## Information

To install the transifex client, install python, then run `pip install transifex-client`, or using the chocolatey package `choco install transifex-client`.

| | Stable | Pre-release |
| :------------: | :--------------------------------------------------------------------------------------------------------------------------------------------------------: | :-----------------------------------------------------------------------------------------------------------------------------------------------------------: |
| GitHub Release | [![GitHub release](https://img.shields.io/github/release/cake-contrib/Cake.Transifex.svg)](https://github.com/cake-contrib/Cake.Transifex/releases/latest) | [![GitHub (pre-)release](https://img.shields.io/github/release/cake-contrib/Cake.Transifex/all.svg)](https://github.com/cake-contrib/Cake.Transifex/releases) |
| NuGet | [![NuGet](https://img.shields.io/nuget/v/Cake.Transifex.svg)](https://nuget.org/packages/Cake.Transifex) | [![NuGet Pre Release](https://img.shields.io/nuget/vpre/Cake.Transifex.svg)](https://nuget.org/packages/Cake.Transifex) |

### Where to get the addin

Officially published versions are available on [NuGet](https://www.nuget.org/packages/Cake.Transifex/).
Development versions is available at the following nuget api endpoint:

### Usage

The following aliases is available from the cake build script:

- `TransifexInit` -> Initialize a simple configuration file in the repository
- `TransifexStatus` -> Get the status of the current translations in the local repository.
- `TransifexPush` -> Push translations to the remote transifex server (Optionally also the source file)
- `TransifexPull` -> Pull monitored translations from the remote transifex server

## Build Status

| | master | develop |
| :------: | :-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
| AppVeyor | [![AppVeyor branch master](https://img.shields.io/appveyor/ci/cakecontrib/cake-transifex/master.svg)](https://ci.appveyor.com/project/cakecontrib/cake-transifex/branch/master) | [![AppVeyor branch develop](https://img.shields.io/appveyor/ci/cakecontrib/cake-transifex/develop.svg)](https://ci.appveyor.com/project/cakecontrib/cake-transifex/branch/develop) |
| Travis | [![Build Status](https://travis-ci.org/cake-contrib/Cake.Transifex.svg?branch=master)](https://travis-ci.org/cake-contrib/Cake.Transifex) | [![Build Status](https://travis-ci.org/cake-contrib/Cake.Transifex.svg?branch=develop)](https://travis-ci.org/cake-contrib/Cake.Transifex) |

## Code Coverage

| | master | develop |
| :-------: | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
| Codecov | [![Codecov branch](https://img.shields.io/codecov/c/github/cake-contrib/Cake.Transifex/master.svg)](https://codecov.io/gh/cake-contrib/Cake.Transifex/branch/master) | [![Codecov branch](https://img.shields.io/codecov/c/github/cake-contrib/Cake.Transifex/develop.svg)](https://codecov.io/gh/cake-contrib/Cake.Transifex/branch/develop) |
| Coveralls | [![Coveralls branch](https://img.shields.io/coveralls/cake-contrib/Cake.Transifex/master.svg)](https://coveralls.io/github/cake-contrib/Cake.Transifex?branch=master) | [![Coveralls branch](https://img.shields.io/coveralls/cake-contrib/Cake.Transifex/develop.svg)](https://coveralls.io/github/cake-contrib/Cake.Transifex?branch=develop) |

## Quick Links

- [Addin Documentation](https://cake-contrib.github.io/Cake.Transifex)
- [Transifex Documentation](https://docs.transifex.com/)

## Chat Room

Please do not hesitate to reash out in the [GitHub discussions](https://github.com/cake-build/cake/discussions/categories/extension-q-a) if you have any issues or questions using this addin.

## Building Cake.Transifex

Please see [Building documentation](https://cake-contrib.github.io/Cake.Transifex/docs/building/) on how to build the Cake.Transifex addin.

## Contributors

Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):



Kim J. Nordmo
Kim J. Nordmo

๐Ÿšง
Gary Ewan Park
Gary Ewan Park

๐Ÿ’ฌ ๐Ÿค” ๐Ÿ‘€ ๐Ÿ“–
README Bot
README Bot

๐Ÿ“–
jericho
jericho

๐Ÿค” ๐Ÿ’ฌ
Martin Bjรถrkstrรถm
Martin Bjรถrkstrรถm

๐Ÿ’ฌ
D. Domig
D. Domig

๐Ÿ“–
C. Augusto Proiete
C. Augusto Proiete

๐Ÿค” ๐Ÿ’ป


Nils Andresen
Nils Andresen

๐Ÿค”

This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification.
Contributions of any kind welcome!

[all-contributors]: https://github.com/all-contributors/all-contributors
[all-contributorsimage]: https://img.shields.io/github/all-contributors/cake-contrib/Cake.Codecov.svg?color=orange&style=flat-square