Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/crowdin/crowdin-api-client-python
Python client library for Crowdin API
https://github.com/crowdin/crowdin-api-client-python
api client crowdin-api hacktoberfest python sdk
Last synced: 2 days ago
JSON representation
Python client library for Crowdin API
- Host: GitHub
- URL: https://github.com/crowdin/crowdin-api-client-python
- Owner: crowdin
- License: mit
- Created: 2021-02-01T15:45:02.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2024-10-30T12:18:35.000Z (14 days ago)
- Last Synced: 2024-10-30T13:25:31.756Z (14 days ago)
- Topics: api, client, crowdin-api, hacktoberfest, python, sdk
- Language: Python
- Homepage: https://pypi.org/project/crowdin-api-client/
- Size: 800 KB
- Stars: 55
- Watchers: 5
- Forks: 30
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Crowdin Python client [](https://twitter.com/intent/tweet?url=https%3A%2F%2Fgithub.com%2Fcrowdin%2Fcrowdin-api-client-python&text=The%20Crowdin%20Python%20client%20is%20a%20lightweight%20interface%20to%20the%20Crowdin%20API) [](https://github.com/crowdin/crowdin-api-client-python/stargazers)
The Crowdin Python client is a lightweight interface to the Crowdin API. 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.
[**`API Client Docs`**](https://crowdin.github.io/crowdin-api-client-python/) |
[**`Crowdin API`**](https://developer.crowdin.com/api/v2/) |
[**`Crowdin Enterprise API`**](https://developer.crowdin.com/enterprise/api/v2/)
[](https://pypi.org/project/crowdin-api-client/)
[](https://pepy.tech/project/crowdin-api-client)
[](https://pypi.org/project/crowdin-api-client/)
[](https://codecov.io/gh/crowdin/crowdin-api-client-python)
[](https://github.com/crowdin/crowdin-api-client-python/issues)
[](https://github.com/crowdin/crowdin-api-client-python/blob/master/LICENSE)
## Installation
```console
pip install crowdin-api-client
```
## Quick Start
### Create and list projects
```python
from crowdin_api import CrowdinClient
class FirstCrowdinClient(CrowdinClient):
TOKEN = "__token__"
PROJECT_ID = 1 # Optional, set project id for all API's
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
EXTENDED_REQUEST_PARAMS = {"some-parameters": ""} # Optional, sets additional parameters for request
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
```
Alternatively, you can create an instance of the CrowdinClient class with params like this:
```python
from crowdin_api import CrowdinClient
# use the lower-case version of any of the constants above,
# at least provide token
client = CrowdinClient(token='__token__')
# ... continue as above
```
### Add a file
```python
from crowdin_api import CrowdinClient
client = CrowdinClient(token='__token__')
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)
```
### Fetch all records
It is possible to fetch all records from paginatable methods (where we have limit and offset in arguments).
```python
from crowdin_api import CrowdinClient
client = CrowdinClient(token='__token__')
# get all projects
print(client.projects.with_fetch_all().list_projects())
# get projects but not more than 1000
print(client.projects.with_fetch_all(1000).list_projects())
```
### Extended request parameters
The `EXTENDED_REQUEST_PARAMS` parameter allows you to set additional parameters for requests. For example, you can configure proxies or certificates.
The Client uses the [requests](https://pypi.org/project/requests/) library to make HTTP requests. You can pass any parameters that `requests` supports:
```python
def request(
self,
method,
url,
params=None,
data=None,
headers=None,
cookies=None,
files=None,
auth=None,
timeout=None,
allow_redirects=True,
proxies=None,
hooks=None,
stream=None,
verify=None,
cert=None,
json=None,
):
```
For example, you can set a [proxy](https://requests.readthedocs.io/en/latest/api/#requests.Session.proxies):
```python
from crowdin_api import CrowdinClient
http_proxy = "http://10.10.1.10:3128"
https_proxy = "https://10.10.1.11:1080"
ftp_proxy = "ftp://10.10.1.10:3128"
proxies = {
"http": http_proxy,
"https": https_proxy,
"ftp": ftp_proxy
}
class FirstCrowdinClient(CrowdinClient):
EXTENDED_REQUEST_PARAMS = {"proxies": proxies}
```
## Seeking Assistance
If you find any problems or would like to suggest a feature, please read the [How can I contribute](https://github.com/crowdin/crowdin-api-client-python/blob/main/CONTRIBUTING.md#how-can-i-contribute) section in our contributing guidelines.
## Contributing
If you would like to contribute please read the [Contributing](https://github.com/crowdin/crowdin-api-client-python/blob/main/CONTRIBUTING.md) 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.