{"id":18980667,"url":"https://github.com/sublimetext/sublime_lib","last_synced_at":"2026-02-15T11:10:57.721Z","repository":{"id":48934201,"uuid":"127953676","full_name":"SublimeText/sublime_lib","owner":"SublimeText","description":"Utility library for frequently used functionality in Sublime Text and convenience functions or classes","archived":false,"fork":false,"pushed_at":"2021-07-05T02:06:51.000Z","size":787,"stargazers_count":52,"open_issues_count":22,"forks_count":4,"subscribers_count":13,"default_branch":"master","last_synced_at":"2025-04-16T15:15:15.959Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://sublimetext.github.io/sublime_lib","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/SublimeText.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-04-03T18:46:58.000Z","updated_at":"2024-02-24T05:40:28.000Z","dependencies_parsed_at":"2022-09-11T21:11:21.234Z","dependency_job_id":null,"html_url":"https://github.com/SublimeText/sublime_lib","commit_stats":null,"previous_names":[],"tags_count":14,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SublimeText%2Fsublime_lib","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SublimeText%2Fsublime_lib/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SublimeText%2Fsublime_lib/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SublimeText%2Fsublime_lib/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/SublimeText","download_url":"https://codeload.github.com/SublimeText/sublime_lib/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249774516,"owners_count":21323634,"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-11-08T16:07:28.410Z","updated_at":"2026-02-15T11:10:57.712Z","avatar_url":"https://github.com/SublimeText.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# sublime_lib\n\nA utility library for Sublime Text, \nproviding a variety of convenience features.\n\n## Installation\n\nTo make use of sublime_lib in a package...\n\n1. declare it as [dependency](https://packagecontrol.io/docs/dependencies):\n\n   Create a file named `dependencies.json`\n   with the following contents in package's root directory:\n\n   ```json\n   {\n       \"*\": {\n           \"*\": [\n               \"sublime_lib\"\n           ]\n       }\n   }\n   ```\n\n   Open _Command Palette_ and run `Package Control: Satisfy Libraries`\n   to ensure sublime_lib is installed and available for use.\n\n2. Import sublime_lib in plugins, which want to make use of it.\n\n   ```python\n   import sublime_lib\n   ```\n\n## Features\n\nFor complete documentation of all features,\nsee the [API documentation](https://sublimetext.github.io/sublime_lib/).\n\nHighlights include:\n\n- [`ActivityIndicator`](https://sublimetext.github.io/sublime_lib/#activity-indicator) context manager to indicate background activity via status bar.\n- [`ResourcePath`](https://sublimetext.github.io/sublime_lib/#sublime_lib.ResourcePath), a [pathlib.Path](https://docs.python.org/3/library/pathlib.html) inspired representation of ST's resource paths,\n  with methods to convert from and to filesystem paths.\n- [`SettingsDict`](https://sublimetext.github.io/sublime_lib/modules/sublime_lib.settings_dict.html) provides a standard Python `dict` inspired interface for `sublime.Settings` objects.\n- [`OutputPanel`](https://sublimetext.github.io/sublime_lib/modules/sublime_lib.output_panel.html), extending `ViewStream` to provide additional functionality for output panel views.\n- [`ViewStream`](https://sublimetext.github.io/sublime_lib/modules/sublime_lib.view_stream.html), a standard [Python IO stream](https://docs.python.org/3/library/io.html#io.TextIOBase) wrapping a `sublime.View` object\n\n### Deprecated\n\nThe [`flags` submodule](https://sublimetext.github.io/sublime_lib/#module-sublime_lib.flags) is deprecated in favour of native API, available as of ST4135.\n\nThe [`syntax` submodule](https://sublimetext.github.io/sublime_lib/modules/sublime_lib.syntax.html), is marked deprecated in favour of native API functions, available as of ST4.\n\n## Releasing a new version\n\n1. Create a tag in the format `v\u003cmajor\u003e.\u003cminor\u003e.\u003cpatch\u003e`\n2. Push the tag to origin.\n\nA GitHub action should be created that builds a WHEEL file,\ncreates a release for this tag\nand attaches the WHEEL file as an artefact.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsublimetext%2Fsublime_lib","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsublimetext%2Fsublime_lib","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsublimetext%2Fsublime_lib/lists"}