{"id":16063537,"url":"https://github.com/crmne/slskd-python-client","last_synced_at":"2025-11-11T09:30:54.722Z","repository":{"id":176951151,"uuid":"659765626","full_name":"crmne/slskd-python-client","owner":"crmne","description":"A slskd python client","archived":false,"fork":false,"pushed_at":"2023-08-14T21:15:44.000Z","size":258,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-01-01T22:42:33.230Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/crmne.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-06-28T14:07:53.000Z","updated_at":"2023-06-28T14:11:42.000Z","dependencies_parsed_at":null,"dependency_job_id":"0be072c3-2c14-4a8a-a23e-2618840e9757","html_url":"https://github.com/crmne/slskd-python-client","commit_stats":null,"previous_names":["crmne/slskd-python-client"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/crmne%2Fslskd-python-client","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/crmne%2Fslskd-python-client/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/crmne%2Fslskd-python-client/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/crmne%2Fslskd-python-client/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/crmne","download_url":"https://codeload.github.com/crmne/slskd-python-client/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240054824,"owners_count":19740892,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-10-09T05:01:29.789Z","updated_at":"2025-11-11T09:30:54.716Z","avatar_url":"https://github.com/crmne.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# slskd\nA python client for slskd\n\nThis Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:\n\n- API version: 0.17.8.0\n- Package version: 1.0.0\n- Build package: org.openapitools.codegen.languages.PythonNextgenClientCodegen\nFor more information, please visit [https://paolino.me](https://paolino.me)\n\n## Requirements.\n\nPython 3.7+\n\n## Installation \u0026 Usage\n### pip install\n\nIf the python package is hosted on a repository, you can install directly using:\n\n```sh\npip install git+https://github.com/crmne/slskd-python-client.git\n```\n(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/crmne/slskd-python-client.git`)\n\nThen import the package:\n```python\nimport slskd\n```\n\n### Setuptools\n\nInstall via [Setuptools](http://pypi.python.org/pypi/setuptools).\n\n```sh\npython setup.py install --user\n```\n(or `sudo python setup.py install` to install the package for all users)\n\nThen import the package:\n```python\nimport slskd\n```\n\n### Tests\n\nExecute `pytest` to run the tests.\n\n## Getting Started\n\nPlease follow the [installation procedure](#installation--usage) and then run the following:\n\n```python\n\nimport time\nimport slskd\nfrom slskd.rest import ApiException\nfrom pprint import pprint\n\n# Defining the host is optional and defaults to http://localhost:5030/api/v0\n# See configuration.py for a list of all supported configuration parameters.\nconfiguration = slskd.Configuration(\n    host = \"http://localhost:5030/api/v0\"\n)\n\n# The client must configure the authentication and authorization parameters\n# in accordance with the API server security policy.\n# Examples for each auth method are provided below, use the example that\n# satisfies your auth use case.\n\n# Configure API key authorization: ApiKeyAuth\nconfiguration.api_key['ApiKeyAuth'] = os.environ[\"API_KEY\"]\n\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'\n\n\n# Enter a context with an instance of the API client\nasync with slskd.ApiClient(configuration) as api_client:\n    # Create an instance of the API class\n    api_instance = slskd.ApplicationApi(api_client)\n\n    try:\n        # Stops the application.\n        api_response = await api_instance.application_delete()\n        print(\"The response of ApplicationApi-\u003eapplication_delete:\\n\")\n        pprint(api_response)\n    except ApiException as e:\n        print(\"Exception when calling ApplicationApi-\u003eapplication_delete: %s\\n\" % e)\n\n```\n\n## Documentation for API Endpoints\n\nAll URIs are relative to *http://localhost:5030/api/v0*\n\nClass | Method | HTTP request | Description\n------------ | ------------- | ------------- | -------------\n*ApplicationApi* | [**application_delete**](docs/ApplicationApi.md#application_delete) | **DELETE** /application | Stops the application.\n*ApplicationApi* | [**application_dump_get**](docs/ApplicationApi.md#application_dump_get) | **GET** /application/dump |\n*ApplicationApi* | [**application_gc_post**](docs/ApplicationApi.md#application_gc_post) | **POST** /application/gc | Forces garbage collection.\n*ApplicationApi* | [**application_get**](docs/ApplicationApi.md#application_get) | **GET** /application | Gets the current state of the application.\n*ApplicationApi* | [**application_put**](docs/ApplicationApi.md#application_put) | **PUT** /application | Restarts the application.\n*ApplicationApi* | [**application_version_get**](docs/ApplicationApi.md#application_version_get) | **GET** /application/version | Gets the current application version.\n*ApplicationApi* | [**application_version_latest_get**](docs/ApplicationApi.md#application_version_latest_get) | **GET** /application/version/latest | Checks for updates.\n*ConversationsApi* | [**conversations_get**](docs/ConversationsApi.md#conversations_get) | **GET** /conversations | Gets all active conversations.\n*ConversationsApi* | [**conversations_username_delete**](docs/ConversationsApi.md#conversations_username_delete) | **DELETE** /conversations/{username} | Closes the conversation associated with the given username.\n*ConversationsApi* | [**conversations_username_get**](docs/ConversationsApi.md#conversations_username_get) | **GET** /conversations/{username} | Gets the conversation associated with the specified username.\n*ConversationsApi* | [**conversations_username_id_put**](docs/ConversationsApi.md#conversations_username_id_put) | **PUT** /conversations/{username}/{id} | Acknowledges the given message id for the given username.\n*ConversationsApi* | [**conversations_username_messages_get**](docs/ConversationsApi.md#conversations_username_messages_get) | **GET** /conversations/{username}/messages |\n*ConversationsApi* | [**conversations_username_post**](docs/ConversationsApi.md#conversations_username_post) | **POST** /conversations/{username} | Sends a private message to the specified username.\n*ConversationsApi* | [**conversations_username_put**](docs/ConversationsApi.md#conversations_username_put) | **PUT** /conversations/{username} | Acknowledges all messages from the given username.\n*LogsApi* | [**logs_get**](docs/LogsApi.md#logs_get) | **GET** /logs | Gets the last few application logs.\n*MetricsApi* | [**metrics_get**](docs/MetricsApi.md#metrics_get) | **GET** /metrics | Gets application metrics.\n*OptionsApi* | [**options_debug_get**](docs/OptionsApi.md#options_debug_get) | **GET** /options/debug | Gets the debug view of the current application options.\n*OptionsApi* | [**options_get**](docs/OptionsApi.md#options_get) | **GET** /options | Gets the current application options.\n*OptionsApi* | [**options_startup_get**](docs/OptionsApi.md#options_startup_get) | **GET** /options/startup | Gets the application options provided at startup.\n*OptionsApi* | [**options_yaml_get**](docs/OptionsApi.md#options_yaml_get) | **GET** /options/yaml |\n*OptionsApi* | [**options_yaml_location_get**](docs/OptionsApi.md#options_yaml_location_get) | **GET** /options/yaml/location |\n*OptionsApi* | [**options_yaml_post**](docs/OptionsApi.md#options_yaml_post) | **POST** /options/yaml |\n*OptionsApi* | [**options_yaml_validate_post**](docs/OptionsApi.md#options_yaml_validate_post) | **POST** /options/yaml/validate |\n*PublicChatApi* | [**publicchat_delete**](docs/PublicChatApi.md#publicchat_delete) | **DELETE** /publicchat | Stops public chat.\n*PublicChatApi* | [**publicchat_post**](docs/PublicChatApi.md#publicchat_post) | **POST** /publicchat | Starts public chat.\n*RelayApi* | [**relay_agent_delete**](docs/RelayApi.md#relay_agent_delete) | **DELETE** /relay/agent | Disconnects from the connected controller.\n*RelayApi* | [**relay_agent_put**](docs/RelayApi.md#relay_agent_put) | **PUT** /relay/agent | Connects to the configured controller.\n*RelayApi* | [**relay_controller_downloads_token_get**](docs/RelayApi.md#relay_controller_downloads_token_get) | **GET** /relay/controller/downloads/{token} | Downloads a file from the connected controller.\n*RelayApi* | [**relay_controller_files_token_post**](docs/RelayApi.md#relay_controller_files_token_post) | **POST** /relay/controller/files/{token} | Uploads a file to the connected controller.\n*RelayApi* | [**relay_controller_shares_token_post**](docs/RelayApi.md#relay_controller_shares_token_post) | **POST** /relay/controller/shares/{token} | Uploads share information to the connected controller.\n*RoomsApi* | [**rooms_available_get**](docs/RoomsApi.md#rooms_available_get) | **GET** /rooms/available | Gets a list of rooms from the server.\n*RoomsApi* | [**rooms_joined_get**](docs/RoomsApi.md#rooms_joined_get) | **GET** /rooms/joined | Gets all rooms.\n*RoomsApi* | [**rooms_joined_post**](docs/RoomsApi.md#rooms_joined_post) | **POST** /rooms/joined | Joins a room.\n*RoomsApi* | [**rooms_joined_room_name_delete**](docs/RoomsApi.md#rooms_joined_room_name_delete) | **DELETE** /rooms/joined/{roomName} | Leaves a room.\n*RoomsApi* | [**rooms_joined_room_name_get**](docs/RoomsApi.md#rooms_joined_room_name_get) | **GET** /rooms/joined/{roomName} | Gets the specified room.\n*RoomsApi* | [**rooms_joined_room_name_members_post**](docs/RoomsApi.md#rooms_joined_room_name_members_post) | **POST** /rooms/joined/{roomName}/members | Adds a member to a private room.\n*RoomsApi* | [**rooms_joined_room_name_messages_get**](docs/RoomsApi.md#rooms_joined_room_name_messages_get) | **GET** /rooms/joined/{roomName}/messages | Gets the current list of messages for the specified room.\n*RoomsApi* | [**rooms_joined_room_name_messages_post**](docs/RoomsApi.md#rooms_joined_room_name_messages_post) | **POST** /rooms/joined/{roomName}/messages | Sends a message to the specified room.\n*RoomsApi* | [**rooms_joined_room_name_ticker_post**](docs/RoomsApi.md#rooms_joined_room_name_ticker_post) | **POST** /rooms/joined/{roomName}/ticker | Sets a ticker for the specified room.\n*RoomsApi* | [**rooms_joined_room_name_users_get**](docs/RoomsApi.md#rooms_joined_room_name_users_get) | **GET** /rooms/joined/{roomName}/users | Gets the current list of users for the specified room.\n*SearchesApi* | [**searches_get**](docs/SearchesApi.md#searches_get) | **GET** /searches | Gets the list of active and completed searches.\n*SearchesApi* | [**searches_id_delete**](docs/SearchesApi.md#searches_id_delete) | **DELETE** /searches/{id} | Deletes the search corresponding to the specified id.\n*SearchesApi* | [**searches_id_get**](docs/SearchesApi.md#searches_id_get) | **GET** /searches/{id} | Gets the state of the search corresponding to the specified id.\n*SearchesApi* | [**searches_id_put**](docs/SearchesApi.md#searches_id_put) | **PUT** /searches/{id} | Stops the search corresponding to the specified id.\n*SearchesApi* | [**searches_id_responses_get**](docs/SearchesApi.md#searches_id_responses_get) | **GET** /searches/{id}/responses | Gets the state of the search corresponding to the specified id.\n*SearchesApi* | [**searches_post**](docs/SearchesApi.md#searches_post) | **POST** /searches | Performs a search for the specified request.\n*ServerApi* | [**server_delete**](docs/ServerApi.md#server_delete) | **DELETE** /server | Disconnects the client.\n*ServerApi* | [**server_get**](docs/ServerApi.md#server_get) | **GET** /server | Retrieves the current state of the server.\n*ServerApi* | [**server_put**](docs/ServerApi.md#server_put) | **PUT** /server | Connects the client.\n*SessionApi* | [**session_enabled_get**](docs/SessionApi.md#session_enabled_get) | **GET** /session/enabled | Checks whether security is enabled.\n*SessionApi* | [**session_get**](docs/SessionApi.md#session_get) | **GET** /session | Checks whether the provided authentication is valid.\n*SessionApi* | [**session_post**](docs/SessionApi.md#session_post) | **POST** /session | Logs in.\n*SharesApi* | [**shares_contents_get**](docs/SharesApi.md#shares_contents_get) | **GET** /shares/contents | Returns a list of all shared directories and files.\n*SharesApi* | [**shares_delete**](docs/SharesApi.md#shares_delete) | **DELETE** /shares | Cancels a share scan, if one is running.\n*SharesApi* | [**shares_get**](docs/SharesApi.md#shares_get) | **GET** /shares | Gets the current list of shares.\n*SharesApi* | [**shares_id_contents_get**](docs/SharesApi.md#shares_id_contents_get) | **GET** /shares/{id}/contents | Gets the contents of the share associated with the specified \u0026lt;see paramref\u0026#x3D;\\\u0026quot;id\\\u0026quot; /\u0026gt;.\n*SharesApi* | [**shares_id_get**](docs/SharesApi.md#shares_id_get) | **GET** /shares/{id} | Gets the share associated with the specified \u0026lt;see paramref\u0026#x3D;\\\u0026quot;id\\\u0026quot; /\u0026gt;.\n*SharesApi* | [**shares_put**](docs/SharesApi.md#shares_put) | **PUT** /shares | Initiates a scan of the configured shares.\n*TransfersApi* | [**transfers_downloads_all_completed_delete**](docs/TransfersApi.md#transfers_downloads_all_completed_delete) | **DELETE** /transfers/downloads/all/completed | Removes all completed downloads, regardless of whether they failed or succeeded.\n*TransfersApi* | [**transfers_downloads_get**](docs/TransfersApi.md#transfers_downloads_get) | **GET** /transfers/downloads | Gets all downloads.\n*TransfersApi* | [**transfers_downloads_username_get**](docs/TransfersApi.md#transfers_downloads_username_get) | **GET** /transfers/downloads/{username} | Gets all downloads for the specified username.\n*TransfersApi* | [**transfers_downloads_username_id_delete**](docs/TransfersApi.md#transfers_downloads_username_id_delete) | **DELETE** /transfers/downloads/{username}/{id} | Cancels the specified download.\n*TransfersApi* | [**transfers_downloads_username_id_get**](docs/TransfersApi.md#transfers_downloads_username_id_get) | **GET** /transfers/downloads/{username}/{id} |\n*TransfersApi* | [**transfers_downloads_username_id_position_get**](docs/TransfersApi.md#transfers_downloads_username_id_position_get) | **GET** /transfers/downloads/{username}/{id}/position | Gets the downlaod for the specified username matching the specified filename, and requests  the current place in the remote queue of the specified download.\n*TransfersApi* | [**transfers_downloads_username_post**](docs/TransfersApi.md#transfers_downloads_username_post) | **POST** /transfers/downloads/{username} | Enqueues the specified download.\n*TransfersApi* | [**transfers_uploads_all_completed_delete**](docs/TransfersApi.md#transfers_uploads_all_completed_delete) | **DELETE** /transfers/uploads/all/completed | Removes all completed uploads, regardless of whether they failed or succeeded.\n*TransfersApi* | [**transfers_uploads_get**](docs/TransfersApi.md#transfers_uploads_get) | **GET** /transfers/uploads | Gets all uploads.\n*TransfersApi* | [**transfers_uploads_username_get**](docs/TransfersApi.md#transfers_uploads_username_get) | **GET** /transfers/uploads/{username} | Gets all uploads for the specified username.\n*TransfersApi* | [**transfers_uploads_username_id_delete**](docs/TransfersApi.md#transfers_uploads_username_id_delete) | **DELETE** /transfers/uploads/{username}/{id} | Cancels the specified upload.\n*TransfersApi* | [**transfers_uploads_username_id_get**](docs/TransfersApi.md#transfers_uploads_username_id_get) | **GET** /transfers/uploads/{username}/{id} | Gets the upload for the specified username matching the specified filename.\n*UsersApi* | [**users_username_browse_get**](docs/UsersApi.md#users_username_browse_get) | **GET** /users/{username}/browse | Retrieves the files shared by the specified username.\n*UsersApi* | [**users_username_browse_status_get**](docs/UsersApi.md#users_username_browse_status_get) | **GET** /users/{username}/browse/status | Retrieves the status of the current browse operation for the specified username, if any.\n*UsersApi* | [**users_username_directory_post**](docs/UsersApi.md#users_username_directory_post) | **POST** /users/{username}/directory | Retrieves the files from the specified directory from the specified username.\n*UsersApi* | [**users_username_endpoint_get**](docs/UsersApi.md#users_username_endpoint_get) | **GET** /users/{username}/endpoint | Retrieves the address of the specified username.\n*UsersApi* | [**users_username_info_get**](docs/UsersApi.md#users_username_info_get) | **GET** /users/{username}/info | Retrieves information about the specified username.\n*UsersApi* | [**users_username_status_get**](docs/UsersApi.md#users_username_status_get) | **GET** /users/{username}/status | Retrieves status for the specified username.\n\n\n## Documentation For Models\n\n - [AddressFamily](docs/AddressFamily.md)\n - [ApiKeyOptions](docs/ApiKeyOptions.md)\n - [BlacklistedOptions](docs/BlacklistedOptions.md)\n - [BufferOptions](docs/BufferOptions.md)\n - [BuiltInOptions](docs/BuiltInOptions.md)\n - [CertificateOptions](docs/CertificateOptions.md)\n - [ConnectionOptions](docs/ConnectionOptions.md)\n - [Conversation](docs/Conversation.md)\n - [DiagnosticLevel](docs/DiagnosticLevel.md)\n - [DirectoriesOptions](docs/DirectoriesOptions.md)\n - [Directory](docs/Directory.md)\n - [DirectoryContentsRequest](docs/DirectoryContentsRequest.md)\n - [DistributedNetworkOptions](docs/DistributedNetworkOptions.md)\n - [FeatureOptions](docs/FeatureOptions.md)\n - [File](docs/File.md)\n - [FileAttribute](docs/FileAttribute.md)\n - [FileAttributeType](docs/FileAttributeType.md)\n - [FiltersOptions](docs/FiltersOptions.md)\n - [FlagsOptions](docs/FlagsOptions.md)\n - [FtpOptions](docs/FtpOptions.md)\n - [GlobalDownloadOptions](docs/GlobalDownloadOptions.md)\n - [GlobalOptions](docs/GlobalOptions.md)\n - [GlobalUploadOptions](docs/GlobalUploadOptions.md)\n - [GroupsOptions](docs/GroupsOptions.md)\n - [HttpsOptions](docs/HttpsOptions.md)\n - [IPAddress](docs/IPAddress.md)\n - [IPEndPoint](docs/IPEndPoint.md)\n - [Info](docs/Info.md)\n - [IntegrationOptions](docs/IntegrationOptions.md)\n - [JwtOptions](docs/JwtOptions.md)\n - [LeecherOptions](docs/LeecherOptions.md)\n - [LoggerOptions](docs/LoggerOptions.md)\n - [LoginRequest](docs/LoginRequest.md)\n - [MessageDirection](docs/MessageDirection.md)\n - [MetricsAuthenticationOptions](docs/MetricsAuthenticationOptions.md)\n - [MetricsOptions](docs/MetricsOptions.md)\n - [Options](docs/Options.md)\n - [PrivateMessage](docs/PrivateMessage.md)\n - [ProblemDetails](docs/ProblemDetails.md)\n - [ProxyOptions](docs/ProxyOptions.md)\n - [PushbulletOptions](docs/PushbulletOptions.md)\n - [QueueDownloadRequest](docs/QueueDownloadRequest.md)\n - [RelayAgentConfigurationOptions](docs/RelayAgentConfigurationOptions.md)\n - [RelayControllerConfigurationOptions](docs/RelayControllerConfigurationOptions.md)\n - [RelayOptions](docs/RelayOptions.md)\n - [Room](docs/Room.md)\n - [RoomInfo](docs/RoomInfo.md)\n - [RoomMessage](docs/RoomMessage.md)\n - [SearchOptions](docs/SearchOptions.md)\n - [SearchRequest](docs/SearchRequest.md)\n - [ServerState](docs/ServerState.md)\n - [Share](docs/Share.md)\n - [ShareCacheOptions](docs/ShareCacheOptions.md)\n - [SharesOptions](docs/SharesOptions.md)\n - [SoulseekClientStates](docs/SoulseekClientStates.md)\n - [SoulseekOptions](docs/SoulseekOptions.md)\n - [Status](docs/Status.md)\n - [ThresholdOptions](docs/ThresholdOptions.md)\n - [TimeoutOptions](docs/TimeoutOptions.md)\n - [TokenResponse](docs/TokenResponse.md)\n - [Transfer](docs/Transfer.md)\n - [TransferDirection](docs/TransferDirection.md)\n - [TransferStates](docs/TransferStates.md)\n - [UploadOptions](docs/UploadOptions.md)\n - [UserData](docs/UserData.md)\n - [UserDefinedOptions](docs/UserDefinedOptions.md)\n - [UserPresence](docs/UserPresence.md)\n - [WebAuthenticationOptions](docs/WebAuthenticationOptions.md)\n - [WebOptions](docs/WebOptions.md)\n\n\n\u003ca id=\"documentation-for-authorization\"\u003e\u003c/a\u003e\n## Documentation For Authorization\n\n\nAuthentication schemes defined for the API:\n\u003ca id=\"ApiKeyAuth\"\u003e\u003c/a\u003e\n### ApiKeyAuth\n\n- **Type**: API key\n- **API key parameter name**: X-API-KEY\n- **Location**: HTTP header\n\n\n## Author\n\ncarmine@paolino.me\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcrmne%2Fslskd-python-client","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcrmne%2Fslskd-python-client","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcrmne%2Fslskd-python-client/lists"}