Metadata-Version: 2.1
Name: crowdin-api-client
Version: 1.0.1
Summary: Python client library for Crowdin API v2
Home-page: https://github.com/crowdin/crowdin-api-client-python
Author: Сrowdin
Author-email: support@crowdin.com
License: MIT
Project-URL: Documentation, https://support.crowdin.com/api/v2/
Project-URL: Source Code, https://github.com/crowdin/crowdin-api-client-python
Description: [<p align='center'><img src='https://support.crowdin.com/assets/logos/crowdin-dark-symbol.png' data-canonical-src='https://support.crowdin.com/assets/logos/crowdin-dark-symbol.png' width='200' height='200' align='center'/></p>](https://crowdin.com)
        
        # 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:
        - [Crowdin](https://support.crowdin.com/api/v2/)
        - [Crowdin Enterprise](https://support.crowdin.com/enterprise/api/)
        
        **Note:** the Crowdin Python Client is currently under development, so some API methods might be missing.
        
        ## Status
        
        [![PyPI](https://img.shields.io/pypi/v/crowdin-api-client?cacheSeconds=3600)](https://pypi.org/project/crowdin-api-client/)
        [![PyPI - Downloads](https://img.shields.io/pypi/dm/crowdin-api-client?cacheSeconds=3600)](https://pypi.org/project/crowdin-api-client/)
        [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/crowdin-api-client?cacheSeconds=3600)](https://pypi.org/project/crowdin-api-client/)
        ![GitHub Workflow Status](https://img.shields.io/github/workflow/status/crowdin/crowdin-api-client-python/Python%20package)
        [![codecov](https://codecov.io/gh/crowdin/crowdin-api-client-python/branch/main/graph/badge.svg?token=sOUWIcNjWO)](https://codecov.io/gh/crowdin/crowdin-api-client-python)
        [![GitHub issues](https://img.shields.io/github/issues/crowdin/crowdin-api-client-python?cacheSeconds=3600)](https://github.com/crowdin/crowdin-api-client-python/issues)
        [![License](https://img.shields.io/github/license/crowdin/crowdin-api-client-python?cacheSeconds=3600)](https://github.com/crowdin/crowdin-api-client-python/blob/master/LICENSE)
        
        ## Table of Contents
        * [Installation](#installation)
        * [Quick Start](#quick-start)
        * [Seeking Assistance](#seeking-assistance)
        * [Contributing](#contributing)
        * [License](#license)
        
        ## Installation
        
        ```console
        pip install crowdin-api-client
        ```
        
        ## Quick Start
        
        ```python
        from crowdin_api import CrowdinClient
        
        class FirstCrowdinClient(CrowdinClient):
            TOKEN = "__token__"
            ORGANIZATION = "organizationName" # Optional, for Crowdin Enterprise only
        
        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
        ```
        
        ## 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.
        
        Need help working with Crowdin Python client or have any questions? [Contact](https://crowdin.com/contacts) Customer Success Service.
        
        ## Contributing
        
        If you want to contribute please read the [Contributing](https://github.com/crowdin/crowdin-api-client-python/blob/main/CONTRIBUTING.md) guidelines.
        
        ## License
        <pre>
        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.
        </pre>
        
Platform: UNKNOWN
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Requires-Python: >=3.6.*
Description-Content-Type: text/markdown
