diff --git a/LICENSE.txt b/LICENSE.txt index 37cd8bc..ec1a2ae 100644 --- a/LICENSE.txt +++ b/LICENSE.txt @@ -1,12 +1,21 @@ -ConvertAPI -https://www.convertapi.com -(c) 2011-2018 Baltsoft - -ConvertAPI.Python -https://github.com/ConvertAPI/convertapi-library-python -Copyright (c) 2018 Tomas Rutkauskas - -The MIT License -Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: -The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. \ No newline at end of file +MIT License + +Copyright (c) 2012-2026 ConvertAPI + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.md b/README.md index fc09d3f..fbdc8d8 100644 --- a/README.md +++ b/README.md @@ -20,13 +20,13 @@ Install from source with: ### Requirements -* Python 3 with `requests`; tested on Python 3.10–3.14 +* Python 3 with `requests`; tested on Python 3.10 to 3.14 ## Usage ### Configuration -You can get your API credentials at https://www.convertapi.com/a +You can get your API token at https://www.convertapi.com/a/authentication ```python import convertapi @@ -47,7 +47,7 @@ API_TOKEN=api-token HTTPS_PROXY=https://user:pass@127.0.0.1:9000/ python convert ### File conversion Convert a file to PDF example. All supported file formats and options can be found -[here](https://www.convertapi.com/conversions). +[here](https://www.convertapi.com/api). ```python result = convertapi.convert('pdf', { 'File': '/path/to/my_file.docx' }) @@ -85,7 +85,7 @@ result = convertapi.convert( #### Additional conversion parameters ConvertAPI accepts additional conversion parameters depending on selected formats. All conversion -parameters and explanations can be found [here](https://www.convertapi.com/conversions). +parameters and explanations can be found [here](https://www.convertapi.com/api). ```python result = convertapi.convert( @@ -93,14 +93,14 @@ result = convertapi.convert( { 'File': '/path/to/my_file.docx', 'PageRange': '1-10', - 'PdfResolution': '150', + 'Pdfa': True, } ) ``` ### User information -You can always check your usage by fetching [user information](https://www.convertapi.com/doc/user). +You can always check your usage by fetching [user information](https://www.convertapi.com/docs/user-information). ```python user_info = convertapi.user() @@ -111,7 +111,7 @@ print(user_info['ConversionsConsumed']) ### Alternative domain -Set `base_uri` parameter to use other service domains. Dedicated to the region [domain list](https://www.convertapi.com/doc/servers-location). +Set `base_uri` parameter to use other service domains. Dedicated to the region [domain list](https://www.convertapi.com/docs/servers-location). ```python convertapi.base_uri = 'https://eu-v2.convertapi.com/' @@ -142,7 +142,7 @@ Tests marked `live` call the real service and are skipped unless `CONVERT_API_SE ## Contributing -Bug reports and pull requests are welcome on GitHub at https://github.com/ConvertAPI/convertapi-library-python. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct. +Bug reports and pull requests are welcome on GitHub at https://github.com/ConvertAPI/convertapi-library-python. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](https://www.contributor-covenant.org) code of conduct. ## License diff --git a/SECURITY.md b/SECURITY.md new file mode 100644 index 0000000..ddf160b --- /dev/null +++ b/SECURITY.md @@ -0,0 +1,21 @@ +# Security policy + +## Reporting a vulnerability + +Please do not report security vulnerabilities in public GitHub issues, discussions or pull requests. + +Report them privately on GitHub instead: open the [Security tab](https://github.com/ConvertAPI/convertapi-library-python/security) of this repository and click "Report a vulnerability", or go straight to [the report form](https://github.com/ConvertAPI/convertapi-library-python/security/advisories/new). Only you and the maintainers can see the report. + +Please include: + +- the version of the convertapi package and of Python you use; +- the steps to reproduce the issue, or a proof of concept; +- what an attacker could do with it. + +We will confirm that we received your report and keep you updated until it is fixed. Please give us reasonable time to release a fix before you disclose the issue publicly. + +You can use the same private route if you are not sure whether the issue is in this SDK or in the ConvertAPI service itself. + +## Supported versions + +Security fixes are released in the latest version of the [convertapi package on PyPI](https://pypi.org/project/convertapi/). Please check that the issue still occurs with the latest version before you report it.