Python client library for Crowdin API v2
Project description
Crowdin Python client
The Crowdin Python client is a lightweight interface to the Crowdin API v2. It provides common services for making API requests.
Crowdin API is a full-featured RESTful API that helps you to integrate localization into your development process. The endpoints that we use allow you to easily make calls to retrieve information and to execute actions needed.
For more about Crowdin API v2 see the documentation:
Status
Table of Contents
Installation
pip install crowdin-api-client
Quick Start
Create and list projects
from crowdin_api import CrowdinClient
class FirstCrowdinClient(CrowdinClient):
TOKEN = "__token__"
ORGANIZATION = "organizationName" # Optional, for Crowdin Enterprise only
TIMEOUT = 60 # Optional, sets http request timeout.
RETRY_DELAY = 0.1 # Optional, sets the delay between failed requests
MAX_RETRIES = 5 # Optional, sets the number of retries
HEADERS = {"Some-Header": ""} # Optional, sets additional http request headers
PAGE_SIZE = 25 # Optional, sets default page size
client = FirstCrowdinClient()
# Create Project
project_response = client.projects.add_project(name="New project", sourceLanguageId="en")
# Get list of Projects
projects = client.projects.list_projects()
# Get list of Projects with offset and limit
projects = client.projects.list_projects(offset=10, limit=20)
# Get list of Projects by page
projects = client.projects.list_projects(page=2) # offset=25, limit=25
Add a file
from crowdin_api import CrowdinClient
class FirstCrowdinClient(CrowdinClient):
TOKEN = "__token__"
client = FirstCrowdinClient()
file_name = '__path_to_the_file__'
storage = client.storages.add_storage(open(file_name, 'rb'))
my_file = client.source_files.add_file(__project_id__, storage['data']['id'], file_name)
print(my_file)
Seeking Assistance
If you find any problems or would like to suggest a feature, please read the How can I contribute section in our contributing guidelines.
Need help working with Crowdin Python client or have any questions? Contact Customer Success Service.
Contributing
If you want to contribute please read the Contributing guidelines.
License
The Crowdin Python client is licensed under the MIT License. See the LICENSE file distributed with this work for additional information regarding copyright ownership. Except as contained in the LICENSE file, the name(s) of the above copyright holders shall not be used in advertising or otherwise to promote the sale, use or other dealings in this Software without prior written authorization.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for crowdin_api_client-1.1.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9fab333a4886de266343ad2af9eaced768a89ed5c77fb2810403d216bae793d3 |
|
MD5 | 1e7e7b32f78f28d9e884ff64ebcc7bc1 |
|
BLAKE2b-256 | 2e7aa6ae332a59f69d86b785b7f432a3cbbcd9fa6039e15c826638a468de717b |