Merge pull request #99 from lokalise/SPYTHON-21_remove_file

bodrovis · web-flow · commit 187d0ea2ad55 · 2022-07-27T18:15:03.000+03:00
Delete file endpoint
diff --git a/LICENSE b/LICENSE
@@ -1,6 +1,6 @@
 BSD 3 Clause
 
-Copyright 2020 Lokalise Group and Ilya Bodrov
+Copyright 2020 Lokalise Group and Ilya Krukowski
 
 Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
 
diff --git a/Pipfile b/Pipfile
@@ -5,15 +5,15 @@ verify_ssl = true
 
 [dev-packages]
 pytest = "~=7.1"
-vcrpy = "~=4.1"
+vcrpy = "~=4.2"
 pytest-vcr = "~=1.0.2"
 pytest-cov = "~=3.0"
-pylint = "~= 2.13"
+pylint = "~= 2.14"
 pytest-pylint = "~= 0.3"
 mypy = "~= 0.950"
 python-dotenv = "~= 0.19.2"
 autopep8 = "~= 1.6"
 importlib-metadata = "*"
 
 [packages]
-requests = "~=2.27"
+requests = "~=2.28"
diff --git a/Pipfile.lock b/Pipfile.lock
diff --git a/README.md b/README.md
@@ -6,7 +6,7 @@
 [![Downloads](https://pepy.tech/badge/python-lokalise-api)](https://pepy.tech/project/python-lokalise-api)
 [![Docs](https://readthedocs.org/projects/python-lokalise-api/badge/?version=latest&style=flat)](https://python-lokalise-api.readthedocs.io)
 
-Official Python 3 interface for the [Lokalise APIv2](https://app.lokalise.com/api2docs) that represents returned data as Python objects.
+Official Python 3 interface for the [Lokalise APIv2](https://developers.lokalise.com/reference/lokalise-rest-api) that represents returned data as Python objects.
 
 ## Quick start
 
@@ -50,4 +50,4 @@ Find detailed documentation at [python-lokalise-api.readthedocs.io](https://pyth
 
 This plugin is licensed under the [BSD 3 Clause License](https://github.com/lokalise/python-lokalise-api/blob/master/LICENSE).
 
-Copyright (c) [Lokalise team](https://lokalise.com) and [Ilya Bodrov](http://bodrovis.tech)
+Copyright (c) [Lokalise team](https://lokalise.com) and [Ilya Krukowski](http://bodrovis.tech)
diff --git a/docs/additional_info/changelog.rst b/docs/additional_info/changelog.rst
@@ -3,6 +3,16 @@
 Changelog
 =========
 
+1.5.0 (07-Jul-2022)
+-------------------
+
+* Added support for `Delete file endpoint <https://python-lokalise-api.readthedocs.io/en/latest/api/files.html#delete-file>`_:
+
+.. code-block:: python
+
+  response = client.delete_file(project_id, file_id)
+  response['file_deleted'] # => True
+
 1.4.0 (07-Mar-2022)
 -------------------
 
diff --git a/docs/additional_info/exception_handling.rst b/docs/additional_info/exception_handling.rst
@@ -3,7 +3,7 @@
 Exception handling
 ==================
 
-`Learn more about error codes in the official doc <https://app.lokalise.com/api2docs/curl/#resource-errors>`_.
+`Learn more about error codes in the official doc <https://developers.lokalise.com/reference/api-errors>`_.
 
 The plugin may raise the following exceptions:
 
diff --git a/docs/api/branches.rst b/docs/api/branches.rst
@@ -1,7 +1,7 @@
 Branches endpoint
 =================
 
-`Branches documentation <https://app.lokalise.com/api2docs/curl/#resource-branches>`_
+`Branches documentation <https://developers.lokalise.com/reference/list-all-branches>`_
 
 Fetch all branches
 ------------------
diff --git a/docs/api/comments.rst b/docs/api/comments.rst
@@ -1,7 +1,7 @@
 Comments endpoint
 =================
 
-`Comments documentation <https://app.lokalise.com/api2docs/curl/#resource-comments>`_
+`Comments documentation <https://developers.lokalise.com/reference/list-project-comments>`_
 
 Fetch all project comments
 --------------------------
diff --git a/docs/api/contributors.rst b/docs/api/contributors.rst
@@ -1,7 +1,7 @@
 Contributors endpoint
 =====================
 
-`Contributors documentation <https://app.lokalise.com/api2docs/curl/#resource-contributors>`_
+`Contributors documentation <https://developers.lokalise.com/reference/list-all-contributors>`_
 
 Fetch all contributors
 ----------------------
diff --git a/docs/api/files.rst b/docs/api/files.rst
@@ -1,7 +1,7 @@
 Files endpoint
 ==============
 
-`Files documentation <https://app.lokalise.com/api2docs/curl/#resource-files>`_
+`Files documentation <https://developers.lokalise.com/reference/list-all-files>`_
 
 Fetch all files
 ---------------
@@ -69,3 +69,21 @@ Example:
       "replace_breaks": False
   })
   response['bundle_url'] # => "https://s3-eu-west-1.amazonaws.com/path/to/bundle.zip"
+
+Delete file
+-----------
+
+Please note that this endpoint does not support "software localization" projects.
+
+.. py:function:: delete_file(project_id, file_id)
+
+  :param str project_id: ID of the project
+  :param file_id: ID of the file to delete
+  :return: Dictionary with project ID and "file_deleted" set to True
+
+Example:
+
+.. code-block:: python
+
+  response = client.delete_file("123.abc", 1234)
+  response['file_deleted'] # => True
diff --git a/docs/api/getting_started.rst b/docs/api/getting_started.rst
@@ -18,7 +18,7 @@ Install it by running:
 Initializing the client
 -----------------------
 
-In order to perform API requests, you `require a special token <https://app.lokalise.com/api2docs/curl/#resource-authentication>`_
+In order to perform API requests, you `require a special token <https://developers.lokalise.com/reference/api-authentication>`_
 that can be obtained in your personal Lokalise profile (*API tokens* section).
 
 After you've obtained the token, import the plugin and initialize the client:
@@ -34,7 +34,7 @@ You may also check the :ref:`customizing-client` section to learn how to set tim
 Initializing the client with OAuth 2 token
 ------------------------------------------
 
-You can also send API requests with `OAuth 2 tokens <https://python-lokalise-api.readthedocs.io/en/latest/additional_info/oauth2_flow.html>`_. To achieve that, you have to
+You can also send API requests with `OAuth 2 tokens <https://developers.lokalise.com/reference/api-authentication#oauth-2-authentication>`_. To achieve that, you have to
 instantiate a proper class:
 
 .. code-block:: python
@@ -103,7 +103,7 @@ To get access to the actual data, use ``items``:
   first_project.name
   first_project.description
 
-Bulk fetches support `pagination <https://app.lokalise.com/api2docs/curl/#resource-pagination>`_.
+Bulk fetches support `pagination <https://developers.lokalise.com/reference/api-pagination>`_.
 There are two common options available:
 
 * ``"limit"`` (defaults to ``100``, maximum is ``5000``) - number of records to display per page.
diff --git a/docs/api/keys.rst b/docs/api/keys.rst
@@ -1,7 +1,7 @@
 Keys endpoint
 =============
 
-`Keys documentation <https://app.lokalise.com/api2docs/curl/#resource-keys>`_
+`Keys documentation <https://developers.lokalise.com/reference/list-all-keys>`_
 
 Fetch all keys
 --------------
diff --git a/docs/api/languages.rst b/docs/api/languages.rst
@@ -1,7 +1,7 @@
 Languages endpoint
 ==================
 
-`Languages documentation <https://app.lokalise.com/api2docs/curl/#resource-languages>`_
+`Languages documentation <https://developers.lokalise.com/reference/list-system-languages>`_
 
 Fetch all system languages
 --------------------------
diff --git a/docs/api/orders.rst b/docs/api/orders.rst
@@ -1,7 +1,7 @@
 Orders endpoint
 ===============
 
-`Orders documentation <https://app.lokalise.com/api2docs/curl/#resource-orders>`_
+`Orders documentation <https://developers.lokalise.com/reference/list-all-orders>`_
 
 Fetch all orders
 ----------------
diff --git a/docs/api/payment_cards.rst b/docs/api/payment_cards.rst
@@ -1,7 +1,7 @@
 Payment cards endpoint
 ======================
 
-`Payment cards documentation <https://app.lokalise.com/api2docs/curl/#resource-payment-cards>`_
+`Payment cards documentation <https://developers.lokalise.com/reference/list-all-cards>`_
 
 Fetch all payment cards
 -----------------------
diff --git a/docs/api/projects.rst b/docs/api/projects.rst
@@ -1,7 +1,7 @@
 Projects endpoint
 =================
 
-`Projects documentation <https://app.lokalise.com/api2docs/curl/#resource-projects>`_
+`Projects documentation <https://developers.lokalise.com/reference/list-all-projects>`_
 
 Fetch all projects
 ------------------
diff --git a/docs/api/queued_processes.rst b/docs/api/queued_processes.rst
@@ -1,7 +1,7 @@
 Queued processes endpoint
 =========================
 
-`Queued processes documentation <https://app.lokalise.com/api2docs/curl/#resource-queued-processes>`_
+`Queued processes documentation <https://developers.lokalise.com/reference/list-all-processes>`_
 
 Fetch all queued processes
 --------------------------
diff --git a/docs/api/screenshots.rst b/docs/api/screenshots.rst
@@ -1,7 +1,7 @@
 Screenshots endpoint
 ====================
 
-`Screenshots documentation <https://app.lokalise.com/api2docs/curl/#resource-screenshots>`_
+`Screenshots documentation <https://developers.lokalise.com/reference/list-all-screenshots>`_
 
 Fetch all screenshots
 ---------------------
diff --git a/docs/api/segments.rst b/docs/api/segments.rst
@@ -1,7 +1,7 @@
 Segments endpoint
 =================
 
-`Segments documentation <https://app.lokalise.com/api2docs/curl/#resource-segments>`_
+`Segments documentation <https://developers.lokalise.com/reference/list-all-segments-for-key-language>`_
 
 Fetch all segments
 ------------------
diff --git a/docs/api/snapshots.rst b/docs/api/snapshots.rst
@@ -1,7 +1,7 @@
 Snapshots endpoint
 ==================
 
-`Snapshots documentation <https://app.lokalise.com/api2docs/curl/#resource-snapshots>`_
+`Snapshots documentation <https://developers.lokalise.com/reference/list-all-snapshots>`_
 
 Fetch all snapshots
 -------------------
diff --git a/docs/api/tasks.rst b/docs/api/tasks.rst
@@ -1,7 +1,7 @@
 Tasks endpoint
 ==============
 
-`Tasks documentation <https://app.lokalise.com/api2docs/curl/#resource-tasks>`_
+`Tasks documentation <https://developers.lokalise.com/reference/list-all-tasks>`_
 
 Fetch all tasks
 ---------------
diff --git a/docs/api/team_user_billing_details.rst b/docs/api/team_user_billing_details.rst
@@ -1,7 +1,7 @@
 Team user billing details endpoint
 ==================================
 
-`Team user billing details documentation <https://app.lokalise.com/api2docs/curl/#resource-team-user-billing-details>`_
+`Team user billing details documentation <https://developers.lokalise.com/reference/retrieve-team-user-billing-details>`_
 
 Fetch team user billing details
 -------------------------------
diff --git a/docs/api/team_user_groups.rst b/docs/api/team_user_groups.rst
@@ -1,7 +1,7 @@
 Team user groups endpoint
 =========================
 
-`Team user groups documentation <https://app.lokalise.com/api2docs/curl/#resource-team-user-groups>`_
+`Team user groups documentation <https://developers.lokalise.com/reference/list-all-groups>`_
 
 Fetch all team user groups
 --------------------------
diff --git a/docs/api/team_users.rst b/docs/api/team_users.rst
@@ -1,7 +1,7 @@
 Team users endpoint
 ===================
 
-`Team users documentation <https://app.lokalise.com/api2docs/curl/#resource-team-users>`_
+`Team users documentation <https://developers.lokalise.com/reference/list-all-team-users>`_
 
 Fetch all team users
 --------------------
diff --git a/docs/api/teams.rst b/docs/api/teams.rst
@@ -1,7 +1,7 @@
 Teams endpoint
 ==============
 
-`Teams documentation <https://app.lokalise.com/api2docs/curl/#resource-teams>`_
+`Teams documentation <https://developers.lokalise.com/reference/list-all-teams>`_
 
 Fetch all teams
 ---------------
diff --git a/docs/api/translation_providers.rst b/docs/api/translation_providers.rst
@@ -1,7 +1,7 @@
 Translation providers endpoint
 ==============================
 
-`Translation providers documentation <https://app.lokalise.com/api2docs/curl/#resource-translation-providers>`_
+`Translation providers documentation <https://developers.lokalise.com/reference/list-all-providers>`_
 
 Fetch all translation providers
 -------------------------------
diff --git a/docs/api/translation_statuses.rst b/docs/api/translation_statuses.rst
@@ -1,7 +1,7 @@
 Translation statuses endpoint
 =============================
 
-`Translation statuses documentation <https://app.lokalise.com/api2docs/curl/#resource-translation-statuses>`_
+`Translation statuses documentation <https://developers.lokalise.com/reference/list-all-statuses>`_
 
 Fetch all translation statuses
 ------------------------------
diff --git a/docs/api/translations.rst b/docs/api/translations.rst
@@ -1,7 +1,7 @@
 Translations endpoint
 =====================
 
-`Translations documentation <https://app.lokalise.com/api2docs/curl/#resource-translations>`_
+`Translations documentation <https://developers.lokalise.com/reference/list-all-translations>`_
 
 Fetch all translations
 ----------------------
diff --git a/docs/api/webhooks.rst b/docs/api/webhooks.rst
@@ -1,7 +1,7 @@
 Webhooks endpoint
 =================
 
-`Webhooks documentation <https://app.lokalise.com/api2docs/curl/#resource-webhooks>`_
+`Webhooks documentation <https://developers.lokalise.com/reference/list-all-webhooks>`_
 
 Fetch all webhooks
 ------------------
diff --git a/docs/index.rst b/docs/index.rst
@@ -6,7 +6,7 @@
 Lokalise API v2 Python interface
 ================================
 
-Official `Lokalise APIv2 <https://app.lokalise.com/api2docs/curl/>`_ Python
+Official `Lokalise APIv2 <https://developers.lokalise.com/reference/lokalise-rest-api>`_ Python
 interface that represents returned data as Python objects.
 
 .. code-block:: python
diff --git a/lokalise/_version.py b/lokalise/_version.py
@@ -4,4 +4,4 @@
 This module contains plugin metadata.
 """
 
-__version__: str = "1.4.0"
+__version__: str = "1.5.0"
diff --git a/lokalise/client.py b/lokalise/client.py
@@ -398,6 +398,21 @@ def download_files(self, project_id: str,
             download(params=params, parent_id=project_id)
         return response
 
+    def delete_file(self, project_id: str,
+                    file_id: Union[str, int]) -> Dict:
+        """Deletes a file and it's associated keys from the project.
+        File __unassigned__ cannot be deleted.
+        This endpoint does not support "software localization" projects.
+
+        :param str project_id: ID of the project
+        :param file_id: ID of the file to delete
+        :return: Dictionary with project ID and "file_deleted" set to True
+        :rtype dict:
+        """
+        response = self.get_endpoint("files"). \
+            delete(parent_id=project_id, resource_id=file_id)
+        return response
+
     def keys(self,
              project_id: str,
              params: Optional[Dict[str, Any]] = None
diff --git a/lokalise/endpoints/files_endpoint.py b/lokalise/endpoints/files_endpoint.py
@@ -11,7 +11,7 @@
 class FilesEndpoint(BaseEndpoint):
     """Describes files endpoint.
     """
-    PATH = "projects/$parent_id/files"
+    PATH = "projects/$parent_id/files/$resource_id"
 
     def upload(self, params: Dict[str, Any],
                **ids: Optional[Union[str, int]]) -> Dict:
@@ -22,7 +22,7 @@ def upload(self, params: Dict[str, Any],
         :rtype dict:
         """
         path = self.path_with_params(**ids)
-        return request.post(self.client, path + '/upload', params)
+        return request.post(self.client, path + 'upload', params)
 
     def download(self, params: Dict[str, Any],
                  **ids: Optional[Union[str, int]]) -> Dict:
@@ -33,4 +33,4 @@ def download(self, params: Dict[str, Any],
         :rtype dict:
         """
         path = self.path_with_params(**ids)
-        return request.post(self.client, path + '/download', params)
+        return request.post(self.client, path + 'download', params)
diff --git a/lokalise/oauth2/auth.py b/lokalise/oauth2/auth.py
@@ -34,7 +34,8 @@ def auth(self,
              scope: Union[List, str],
              redirect_uri: Optional[str] = None,
              state: Optional[str] = None) -> str:
-        """Generate a new auth URL. Users have to visit it and explicitly approve the requested permissions
+        """Generate a new auth URL. Users have to visit it and
+        explicitly approve the requested permissions
 
         :param scope: Requested scopes
         :type scope: list or str
diff --git a/lokalise/oauth2/request.py b/lokalise/oauth2/request.py
@@ -4,8 +4,8 @@
 This module provides HTTP request methods specifically for OAuth 2 flow.
 """
 
-import requests
 from typing import Optional, Dict
+import requests
 from lokalise.request_utils import raise_on_error, __format_params, __prepare
 from lokalise._version import __version__
 
diff --git a/lokalise/request_utils.py b/lokalise/request_utils.py
diff --git a/setup.cfg b/setup.cfg
diff --git a/setup.py b/setup.py
diff --git a/tests/cassettes/files_test/test_delete_file.yaml b/tests/cassettes/files_test/test_delete_file.yaml
diff --git a/tests/client/files_test.py b/tests/client/files_test.py
