diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index e9cebcd..53ad549 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -109,8 +109,9 @@ test: - poetry run coverage xml artifacts: reports: - cobertura: - - coverage.xml + coverage_report: + coverage_format: cobertura + path: coverage.xml junit: - test_report.xml when: always diff --git a/CHANGELOG.md b/CHANGELOG.md index 229c806..1143470 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,6 +5,18 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). +## [1.8.0] - 2022-06-10 +### Added +* Optional `filename` parameter added to `Translator.translate_document()`, only + required if uploading string or bytes containing file content. + * Pull request [#30](https://github.com/DeepLcom/deepl-python/pull/30) + thanks to [seratch](https://github.com/seratch). +### Changed +* Update contributing guidelines, we can now accept Pull Requests. +### Fixed +* Fix GitLab CI config. + + ## [1.7.0] - 2022-05-18 ### Added * New languages available: Indonesian (`'id'`) and Turkish (`'tr'`). Add language code constants and tests. @@ -165,6 +177,7 @@ Version increased to avoid conflicts with old packages on PyPI. Initial version. +[1.8.0]: https://github.com/DeepLcom/deepl-python/compare/v1.7.0...v1.8.0 [1.7.0]: https://github.com/DeepLcom/deepl-python/compare/v1.6.0...v1.7.0 [1.6.0]: https://github.com/DeepLcom/deepl-python/compare/v1.5.1...v1.6.0 [1.5.1]: https://github.com/DeepLcom/deepl-python/compare/v1.5.0...v1.5.1 diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..f274b19 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,134 @@ + +# Contributor Covenant Code of Conduct + +## Our Pledge + +We as members, contributors, and leaders pledge to make participation in our +community a harassment-free experience for everyone, regardless of age, body +size, visible or invisible disability, ethnicity, sex characteristics, gender +identity and expression, level of experience, education, socio-economic status, +nationality, personal appearance, race, caste, color, religion, or sexual +identity and orientation. + +We pledge to act and interact in ways that contribute to an open, welcoming, +diverse, inclusive, and healthy community. + +## Our Standards + +Examples of behavior that contributes to a positive environment for our +community include: + +* Demonstrating empathy and kindness toward other people +* Being respectful of differing opinions, viewpoints, and experiences +* Giving and gracefully accepting constructive feedback +* Accepting responsibility and apologizing to those affected by our mistakes, + and learning from the experience +* Focusing on what is best not just for us as individuals, but for the overall + community + +Examples of unacceptable behavior include: + +* The use of sexualized language or imagery, and sexual attention or advances of + any kind +* Trolling, insulting or derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or email address, + without their explicit permission +* Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Enforcement Responsibilities + +Community leaders are responsible for clarifying and enforcing our standards of +acceptable behavior and will take appropriate and fair corrective action in +response to any behavior that they deem inappropriate, threatening, offensive, +or harmful. + +Community leaders have the right and responsibility to remove, edit, or reject +comments, commits, code, wiki edits, issues, and other contributions that are +not aligned to this Code of Conduct, and will communicate reasons for moderation +decisions when appropriate. + +## Scope + +This Code of Conduct applies within all community spaces, and also applies when +an individual is officially representing the community in public spaces. +Examples of representing our community include using an official e-mail address, +posting via an official social media account, or acting as an appointed +representative at an online or offline event. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported to the community leaders responsible for enforcement at +[open-source@deepl.com](mailto:open-source@deepl.com). +All complaints will be reviewed and investigated promptly and fairly. + +All community leaders are obligated to respect the privacy and security of the +reporter of any incident. + +## Enforcement Guidelines + +Community leaders will follow these Community Impact Guidelines in determining +the consequences for any action they deem in violation of this Code of Conduct: + +### 1. Correction + +**Community Impact**: Use of inappropriate language or other behavior deemed +unprofessional or unwelcome in the community. + +**Consequence**: A private, written warning from community leaders, providing +clarity around the nature of the violation and an explanation of why the +behavior was inappropriate. A public apology may be requested. + +### 2. Warning + +**Community Impact**: A violation through a single incident or series of +actions. + +**Consequence**: A warning with consequences for continued behavior. No +interaction with the people involved, including unsolicited interaction with +those enforcing the Code of Conduct, for a specified period of time. This +includes avoiding interactions in community spaces as well as external channels +like social media. Violating these terms may lead to a temporary or permanent +ban. + +### 3. Temporary Ban + +**Community Impact**: A serious violation of community standards, including +sustained inappropriate behavior. + +**Consequence**: A temporary ban from any sort of interaction or public +communication with the community for a specified period of time. No public or +private interaction with the people involved, including unsolicited interaction +with those enforcing the Code of Conduct, is allowed during this period. +Violating these terms may lead to a permanent ban. + +### 4. Permanent Ban + +**Community Impact**: Demonstrating a pattern of violation of community +standards, including sustained inappropriate behavior, harassment of an +individual, or aggression toward or disparagement of classes of individuals. + +**Consequence**: A permanent ban from any sort of public interaction within the +community. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], +version 2.1, available at +[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1]. + +Community Impact Guidelines were inspired by +[Mozilla's code of conduct enforcement ladder][Mozilla CoC]. + +For answers to common questions about this code of conduct, see the FAQ at +[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at +[https://www.contributor-covenant.org/translations][translations]. + +[homepage]: https://www.contributor-covenant.org +[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html +[Mozilla CoC]: https://github.com/mozilla/diversity +[FAQ]: https://www.contributor-covenant.org/faq +[translations]: https://www.contributor-covenant.org/translations + diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2fb96ef..a3666ea 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,4 +1,37 @@ -# Contribution guidelines +# Contributing guidelines -We are currently unable to accept Pull Requests. If you would like to suggest changes, please open an -[issue](https://github.com/DeepLcom/deepl-python/issues) instead. +* [Code of Conduct](#code-of-conduct) +* [Issues](#issues) +* [Pull Requests](#pull-requests) + +## Code of Conduct + +This project has a [Code of Conduct](CODE_OF_CONDUCT.md) to which all +contributors must adhere when participating in the project. Instances of +abusive, harassing, or otherwise unacceptable behavior may be reported by +contacting [open-source@deepl.com](mailto:open-source@deepl.com) and/or a +project maintainer. + +## Issues + +If you experience problems using the library, or would like to request a new +feature, please open an [issue][issues]. + +Please provide as much context as possible when you open an issue. The +information you provide must be comprehensive enough for us to reproduce the +issue. + +## Pull Requests + +You are welcome to contribute code and/or documentation in order to fix a bug or +to implement a new feature. Before beginning work, you should create an issue +describing the changes you plan to contribute, to avoid wasting or duplicating +effort. We will then let you know whether we would accept the changes. + +Contributions must be licensed under the same license as the project: +[MIT License](LICENSE). + +Currently automated testing is implemented internally at DeepL, however we plan +to implement publicly visible testing soon. + +[issues]: https://www.github.com/DeepLcom/deepl-python/issues diff --git a/README.md b/README.md index b8e7058..a6ef8c5 100644 --- a/README.md +++ b/README.md @@ -500,8 +500,8 @@ feature, please open an [issue][issues]. ## Development -We are currently unable to accept Pull Requests. If you would like to suggest -changes, please open an [issue][issues] instead. +We welcome Pull Requests, please read the +[contributing guidelines](CONTRIBUTING.md). ### Tests diff --git a/deepl/translator.py b/deepl/translator.py index 480745f..5d72c71 100644 --- a/deepl/translator.py +++ b/deepl/translator.py @@ -851,6 +851,7 @@ def translate_document( target_lang: str, formality: Union[str, Formality] = Formality.DEFAULT, glossary: Union[str, GlossaryInfo, None] = None, + filename: Optional[str] = None, ) -> DocumentStatus: """Upload document, translate it into the target language, and download result. @@ -868,6 +869,8 @@ def translate_document( Formality enum, "less" or "more". :param glossary: (Optional) glossary or glossary ID to use for translation. Must match specified source_lang and target_lang. + :param filename: (Optional) Filename including extension, only required + if uploading string or bytes containing file content. :return: DocumentStatus when document translation completed, this allows the number of billed characters to be queried. @@ -881,6 +884,7 @@ def translate_document( source_lang=source_lang, formality=formality, glossary=glossary, + filename=filename, ) try: diff --git a/deepl/version.py b/deepl/version.py index 1fdb45b..4c2d41a 100644 --- a/deepl/version.py +++ b/deepl/version.py @@ -2,4 +2,4 @@ # Use of this source code is governed by an MIT # license that can be found in the LICENSE file. -VERSION = "1.7.0" +VERSION = "1.8.0" diff --git a/pyproject.toml b/pyproject.toml index 910bccf..6dbdb91 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -3,7 +3,7 @@ line-length = 79 [tool.poetry] name = "deepl" -version = "1.7.0" +version = "1.8.0" description = "Python library for the DeepL API." authors = ["DeepL SE "] license = "MIT" diff --git a/tests/test_general.py b/tests/test_general.py index 7def697..e0f9a35 100644 --- a/tests/test_general.py +++ b/tests/test_general.py @@ -9,7 +9,7 @@ def test_version(): - assert "1.7.0" == deepl.__version__ + assert "1.8.0" == deepl.__version__ @pytest.mark.parametrize(