pyphrase 0.2.0

Client for the Phrase TMS API.

pyphrase

Unofficial Python client for interacting with the Phrase TMS API (formerly Memsource).

About The Project

Work in progress, with some wrinkles to be ironed out and tests to be written. Remember to pin version if you use this for something important!

Modern Python client for interacting with the Phrase TMS API, both for sync and async use.

• Implements all documented paths and operations
• Typed (where possible) for validation and code completion support
• Fully documented methods with complete content of the Phrase TMS API docs.

(back to top)

Built With

The code is based on the Phrase TMS OpenAPI docs as of March 20 2023, which was parsed using datamodel-code-generator for the models and a slightly modified version of swagger-to for the methods.

(back to top)

Getting Started

Installation

Install via pip

pip install pyphrase

Or clone the repo

git clone https://github.com/kuhnemann/pyphrase.git

(back to top)

Usage

Initialize the client with the base URL of your Plunet instance, authenticate and start doing whatever you aim to do.

from pyphrase import SyncPhraseTMSClient, sync_get_phrase_tms_token


phrase_client = SyncPhraseTMSClient()

token_object = sync_get_phrase_tms_token(username=username, password=password)

project_data = phrase_client.project.getProject(token_object.token, projectUid="YOURPROJECT")

Complex objects are included by default, as generated by datamodel-code-generator.

(back to top)

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE for more information.

(back to top)

Contact

Henrik Kühnemann - @hkuhnemann - [e-mail]

Project Link: https://github.com/kuhnemann/pyphrase

(back to top)

(back to top)