Download the PHP package akeneo/crowdin-api without Composer
On this page you can find all versions of the php package akeneo/crowdin-api. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download akeneo/crowdin-api
More information about akeneo/crowdin-api
Files in akeneo/crowdin-api
Package crowdin-api
Short Description Crowdin PHP API client
License MIT
Homepage https://github.com/akeneo/php-crowdin-api
Informations about the package crowdin-api
php-crowdin-api
A simple PHP Crowdin API client http://crowdin.net/page/api.
Crowdin is a translation and localization management platform : http://crowdin.net/
FYI, an official and more complete Ruby Client exists here : https://github.com/crowdin/crowdin-api
Features
PSR-2 conventions and coding standard
Wrap following API methods :
- Add a file, delete a file
- Add a directory, delete a directory, change a directory
- Update File, Upload translations, Upload fresh version of your localization file
- Export Translations, Build fresh package with the latest translations.
- Download Translations, Download last exported translation package (one language or all languages as one zip file).
- Supported Languages, Get supported languages list with Crowdin codes mapped to locale name and standardized codes.
- Translation Status, Track overall translation and proofreading progress of each target language.
- Project Info, Shows project details and meta information.
Missing API methods https://github.com/akeneo/php-crowdin-api/issues?q=is%3Aopen+is%3Aissue+label%3Aapi-method
Requirements
- PHP >= 8.1
- Docker for a better dev experience
How to use ?
Add the following lines in your project composer.json :
Then, to instantiate the client and use available API methods :
Run tests
Use cases
You can take a look at following use cases to see more real life samples.
The Akeneo core team uses this library in Nelson, a command based translation workflow between Crowdin and GitHub (cf https://github.com/akeneo/nelson).
The Sylius core team uses this library in SyliusBot to manage community translations https://github.com/SyliusBot/SyliusBot.
If you use this library don't hesitate to open a PR to explain your use case here :)
Licence
The MIT License (MIT)
Contribution
Feel free to fork and propose PR to complete missing API methods https://github.com/akeneo/php-crowdin-api/issues?q=is%3Aopen+is%3Aissue+label%3Aapi-method
Any contributions are welcome!