<div id="top"></div>
<!-- PROJECT SHIELDS -->
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
[![MIT License][license-shield]][license-url]
[![LinkedIn][linkedin-shield]][linkedin-url]
<!-- PROJECT LOGO -->
<h3 align="center">pyphrase</h3>
<p align="center">
Unofficial Python client for interacting with the Phrase TMS API (formerly Memsource).
<br />
</p>
<!-- ABOUT THE PROJECT -->
## 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 from #latest
- Typed (where possible) for validation and code completion support
- Fully documented methods with complete content of the Phrase TMS API docs
- sync and async clients
### New in 0.3
- Support for pydantic 2.x
- Updated models with current standing
- Fixed many issues, including header encoding for job creation
- Still work in progress and a lot to do
<p align="right">(<a href="#top">back to top</a>)</p>
### Built With
The code is based on the [Phrase TMS OpenAPI docs](https://cloud.memsource.com/web/docs/api) as of January 2024, which was parsed using [datamodel-code-generator](https://github.com/koxudaxi/datamodel-code-generator/) for the models
and a slightly modified version of [swagger-to](https://github.com/Parquery/swagger-to) for the methods.
<p align="right">(<a href="#top">back to top</a>)</p>
<!-- GETTING STARTED -->
## Getting Started
### Installation
Install via pip
```sh
pip install pyphrase
```
Or clone the repo
```sh
git clone https://github.com/kuhnemann/pyphrase.git
```
<p align="right">(<a href="#top">back to top</a>)</p>
<!-- USAGE EXAMPLES -->
## Usage
Initialize the client with the base URL of your Plunet instance, authenticate and start doing whatever you aim to do.
```sh
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.
<p align="right">(<a href="#top">back to top</a>)</p>
See the [open issues](https://github.com/kuhnemann/pyphrase/issues) for a full list of proposed features (and known
issues).
<p align="right">(<a href="#top">back to top</a>)</p>
<!-- CONTRIBUTING -->
## 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
<p align="right">(<a href="#top">back to top</a>)</p>
<!-- LICENSE -->
## License
Distributed under the MIT License. See `LICENSE` for more information.
<p align="right">(<a href="#top">back to top</a>)</p>
<!-- CONTACT -->
## Contact
Henrik Kühnemann - [@hkuhnemann](https://twitter.com/hkuhnemann) - [hello@yellownape.se](mailto:hello@yellownape.se)
Project Link: [https://github.com/kuhnemann/pyphrase](https://github.com/kuhnemann/pyphrase)
<p align="right">(<a href="#top">back to top</a>)</p>
<p align="right">(<a href="#top">back to top</a>)</p>
<!-- MARKDOWN LINKS & IMAGES -->
<!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->
[contributors-shield]: https://img.shields.io/github/contributors/kuhnemann/pyphrase.svg?style=for-the-badge
[contributors-url]: https://github.com/kuhnemann/pyphrase/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/kuhnemann/pyphrase.svg?style=for-the-badge
[forks-url]: https://github.com/kuhnemann/pyphrase/network/members
[stars-shield]: https://img.shields.io/github/stars/kuhnemann/pyphrase.svg?style=for-the-badge
[stars-url]: https://github.com/kuhnemann/pyphrase/stargazers
[issues-shield]: https://img.shields.io/github/issues/kuhnemann/pyphrase.svg?style=for-the-badge
[issues-url]: https://github.com/kuhnemann/pyphrase/issues
[license-shield]: https://img.shields.io/github/license/kuhnemann/pyphrase.svg?style=for-the-badge
[license-url]: https://github.com/kuhnemann/pyphrase/blob/main/LICENCE
[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555
[linkedin-url]: https://linkedin.com/in/henrik-kuhnemann
[product-screenshot]: images/screenshot.png
Raw data
{
"_id": null,
"home_page": "",
"name": "pyphrase",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": "",
"keywords": "phrase tms,memsource,api,translation,localization,tms",
"author": "",
"author_email": "Henrik K\u00fchnemann <hello@yellownape.se>",
"download_url": "https://files.pythonhosted.org/packages/0c/87/a6cc8793aa3b4b9d0ba1ba28d2a72da2a8bb25b0bc25d8fd38a02c10e6ad/pyphrase-0.3.0.tar.gz",
"platform": null,
"description": "<div id=\"top\"></div>\r\n\r\n\r\n<!-- PROJECT SHIELDS -->\r\n\r\n\r\n[![Forks][forks-shield]][forks-url]\r\n[![Stargazers][stars-shield]][stars-url]\r\n[![Issues][issues-shield]][issues-url]\r\n[![MIT License][license-shield]][license-url]\r\n[![LinkedIn][linkedin-shield]][linkedin-url]\r\n\r\n\r\n\r\n<!-- PROJECT LOGO -->\r\n\r\n\r\n<h3 align=\"center\">pyphrase</h3>\r\n\r\n <p align=\"center\">\r\n Unofficial Python client for interacting with the Phrase TMS API (formerly Memsource).\r\n <br />\r\n\r\n\r\n </p>\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n<!-- ABOUT THE PROJECT -->\r\n\r\n## About The Project\r\n\r\nWork 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! \r\n\r\nModern Python client for interacting with the Phrase TMS API, both for sync and async use. \r\n\r\n- Implements all documented paths and operations from #latest\r\n- Typed (where possible) for validation and code completion support\r\n- Fully documented methods with complete content of the Phrase TMS API docs\r\n- sync and async clients\r\n\r\n### New in 0.3\r\n\r\n- Support for pydantic 2.x\r\n- Updated models with current standing\r\n- Fixed many issues, including header encoding for job creation\r\n- Still work in progress and a lot to do\r\n<p align=\"right\">(<a href=\"#top\">back to top</a>)</p>\r\n\r\n### Built With\r\nThe code is based on the [Phrase TMS OpenAPI docs](https://cloud.memsource.com/web/docs/api) as of January 2024, which was parsed using [datamodel-code-generator](https://github.com/koxudaxi/datamodel-code-generator/) for the models\r\nand a slightly modified version of [swagger-to](https://github.com/Parquery/swagger-to) for the methods. \r\n\r\n\r\n\r\n<p align=\"right\">(<a href=\"#top\">back to top</a>)</p>\r\n\r\n\r\n\r\n<!-- GETTING STARTED -->\r\n\r\n## Getting Started\r\n\r\n### Installation\r\n\r\n\r\nInstall via pip\r\n\r\n ```sh\r\n pip install pyphrase\r\n ```\r\n\r\nOr clone the repo\r\n\r\n ```sh\r\n git clone https://github.com/kuhnemann/pyphrase.git\r\n ```\r\n\r\n<p align=\"right\">(<a href=\"#top\">back to top</a>)</p>\r\n\r\n\r\n\r\n<!-- USAGE EXAMPLES -->\r\n\r\n## Usage\r\n\r\nInitialize the client with the base URL of your Plunet instance, authenticate and start doing whatever you aim to do.\r\n\r\n\r\n```sh\r\nfrom pyphrase import SyncPhraseTMSClient, sync_get_phrase_tms_token\r\n\r\n\r\nphrase_client = SyncPhraseTMSClient()\r\n\r\ntoken_object = sync_get_phrase_tms_token(username=username, password=password)\r\n\r\nproject_data = phrase_client.project.getProject(token_object.token, projectUid=\"YOURPROJECT\")\r\n```\r\n\r\n\r\nComplex objects are included by default, as generated by datamodel-code-generator.\r\n\r\n\r\n<p align=\"right\">(<a href=\"#top\">back to top</a>)</p>\r\n\r\n\r\n\r\n\r\nSee the [open issues](https://github.com/kuhnemann/pyphrase/issues) for a full list of proposed features (and known\r\nissues).\r\n\r\n<p align=\"right\">(<a href=\"#top\">back to top</a>)</p>\r\n\r\n\r\n\r\n<!-- CONTRIBUTING -->\r\n\r\n## Contributing\r\n\r\nContributions are what make the open source community such an amazing place to learn, inspire, and create. Any\r\ncontributions you make are **greatly appreciated**.\r\n\r\nIf you have a suggestion that would make this better, please fork the repo and create a pull request. You can also\r\nsimply open an issue with the tag \"enhancement\". Don't forget to give the project a star! Thanks again!\r\n\r\n1. Fork the Project\r\n2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)\r\n3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)\r\n4. Push to the Branch (`git push origin feature/AmazingFeature`)\r\n5. Open a Pull Request\r\n\r\n<p align=\"right\">(<a href=\"#top\">back to top</a>)</p>\r\n\r\n\r\n\r\n<!-- LICENSE -->\r\n\r\n## License\r\n\r\nDistributed under the MIT License. See `LICENSE` for more information.\r\n\r\n<p align=\"right\">(<a href=\"#top\">back to top</a>)</p>\r\n\r\n\r\n\r\n<!-- CONTACT -->\r\n\r\n## Contact\r\n\r\nHenrik K\u00fchnemann - [@hkuhnemann](https://twitter.com/hkuhnemann) - [hello@yellownape.se](mailto:hello@yellownape.se)\r\n\r\nProject Link: [https://github.com/kuhnemann/pyphrase](https://github.com/kuhnemann/pyphrase)\r\n\r\n<p align=\"right\">(<a href=\"#top\">back to top</a>)</p>\r\n\r\n\r\n\r\n<p align=\"right\">(<a href=\"#top\">back to top</a>)</p>\r\n\r\n\r\n\r\n<!-- MARKDOWN LINKS & IMAGES -->\r\n<!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->\r\n\r\n[contributors-shield]: https://img.shields.io/github/contributors/kuhnemann/pyphrase.svg?style=for-the-badge\r\n\r\n[contributors-url]: https://github.com/kuhnemann/pyphrase/graphs/contributors\r\n\r\n[forks-shield]: https://img.shields.io/github/forks/kuhnemann/pyphrase.svg?style=for-the-badge\r\n\r\n[forks-url]: https://github.com/kuhnemann/pyphrase/network/members\r\n\r\n[stars-shield]: https://img.shields.io/github/stars/kuhnemann/pyphrase.svg?style=for-the-badge\r\n\r\n[stars-url]: https://github.com/kuhnemann/pyphrase/stargazers\r\n\r\n[issues-shield]: https://img.shields.io/github/issues/kuhnemann/pyphrase.svg?style=for-the-badge\r\n\r\n[issues-url]: https://github.com/kuhnemann/pyphrase/issues\r\n\r\n[license-shield]: https://img.shields.io/github/license/kuhnemann/pyphrase.svg?style=for-the-badge\r\n\r\n[license-url]: https://github.com/kuhnemann/pyphrase/blob/main/LICENCE\r\n\r\n[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555\r\n\r\n[linkedin-url]: https://linkedin.com/in/henrik-kuhnemann\r\n\r\n[product-screenshot]: images/screenshot.png\r\n",
"bugtrack_url": null,
"license": "",
"summary": "Client for the Phrase TMS API.",
"version": "0.3.0",
"project_urls": {
"Homepage": "https://github.com/kuhnemann/pyphrase"
},
"split_keywords": [
"phrase tms",
"memsource",
"api",
"translation",
"localization",
"tms"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "8b136a4f84007b303e6c53fdd8deb83769542ab4b8f69f0afbd3dfbd53663856",
"md5": "9116ab8cc04198c0040183448fad044d",
"sha256": "64ee7a47b9b52cbe89a8bbc4672a08e22dcc4da9843f64959891017b51207903"
},
"downloads": -1,
"filename": "pyphrase-0.3.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "9116ab8cc04198c0040183448fad044d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 188930,
"upload_time": "2024-02-11T16:15:33",
"upload_time_iso_8601": "2024-02-11T16:15:33.351862Z",
"url": "https://files.pythonhosted.org/packages/8b/13/6a4f84007b303e6c53fdd8deb83769542ab4b8f69f0afbd3dfbd53663856/pyphrase-0.3.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "0c87a6cc8793aa3b4b9d0ba1ba28d2a72da2a8bb25b0bc25d8fd38a02c10e6ad",
"md5": "994f1ab1ad57dc8aa3d55d4b16f5935f",
"sha256": "bd4db559d18b95707d2de75040d5c6504f52f4b3a5d0d4143f96e21611ecfdca"
},
"downloads": -1,
"filename": "pyphrase-0.3.0.tar.gz",
"has_sig": false,
"md5_digest": "994f1ab1ad57dc8aa3d55d4b16f5935f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 130662,
"upload_time": "2024-02-11T16:15:35",
"upload_time_iso_8601": "2024-02-11T16:15:35.354428Z",
"url": "https://files.pythonhosted.org/packages/0c/87/a6cc8793aa3b4b9d0ba1ba28d2a72da2a8bb25b0bc25d8fd38a02c10e6ad/pyphrase-0.3.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-11 16:15:35",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "kuhnemann",
"github_project": "pyphrase",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "pyphrase"
}
JSON
