Skip to content

Commit 880c8ef

Browse files
authored
chore: bump version to v9.5.0 Pre-Release 1; update docs (#751)
* chore: change version branch to "Pre-Release 1" * docs: update docstring for JSON `open_library()` Update method docstring with exact starting and ending versions now that they exist. * docs: update README, CONTRIBUTING.md, & index.md * docs: update roadmap * docs: fix typo in README, change callout * docs: update docs site with v9.5 features * docs: remove warning from index.md
1 parent 1b3b32d commit 880c8ef

18 files changed

+279
-276
lines changed

CONTRIBUTING.md

Lines changed: 8 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,15 @@
11
# Contributing to TagStudio
22

3-
_Last Updated: December 12th, 2024_
3+
_Last Updated: January 30th, 2025_
44

55
Thank you so much for showing interest in contributing to TagStudio! Here are a set of instructions and guidelines for contributing code or documentation to the project. This document will change over time, so make sure that your contributions still line up with the requirements here before submitting a pull request.
66

7-
> [!CAUTION]
8-
> **As of Pull Request [#332](https://github.com/TagStudioDev/TagStudio/pull/332) (SQLite Migration) the `main` branch will marked as experimental before full JSON to SQL parity is operational.** Existing TagStudio libraries are not yet compatible with this change, however they will **NOT be corrupted or deleted** if opened with these versions. Once parity is reached and a stable conversion tool in place, this notice will be removed. UPDATE: As of November 19th, 2024, full parity is rapidly approaching.
9-
>
10-
> For the most recent stable feature release branch, see the [`Alpha-v9.4`](https://github.com/TagStudioDev/TagStudio/tree/Alpha-v9.4) branch. These v9.4 specific features are currently being backported to the SQL-ized `main` branch. (Feel free to help!)
11-
127
## Getting Started
138

149
- Check the [Feature Roadmap](/docs/updates/roadmap.md) page to see what priority features there are, the [FAQ](/README.md/#faq), as well as the open [Issues](https://github.com/TagStudioDev/TagStudio/issues) and [Pull Requests](https://github.com/TagStudioDev/TagStudio/pulls).
1510
- If you'd like to add a feature that isn't on the feature roadmap or doesn't have an open issue, **PLEASE create a feature request** issue for it discussing your intentions so any feedback or important information can be given by the team first.
1611
- We don't want you wasting time developing a feature or making a change that can't/won't be added for any reason ranging from pre-existing refactors to design philosophy differences.
17-
- **Please don't** create pull requests that consist of large refactors, *especially* without discussing them with us first. These end up doing more harm than good for the project by continuously delaying progress and disrupting everyone else's work.
12+
- **Please don't** create pull requests that consist of large refactors, _especially_ without discussing them with us first. These end up doing more harm than good for the project by continuously delaying progress and disrupting everyone else's work.
1813
- If you wish to discuss TagStudio further, feel free to join the [Discord Server](https://discord.com/invite/hRNnVKhF2G)
1914

2015
### Contribution Checklist
@@ -141,13 +136,14 @@ Most of the style guidelines can be checked, fixed, and enforced via Ruff. Older
141136

142137
### Modules & Implementations
143138

139+
- **Do not** modify legacy library code in the `src/core/library/json/` directory
144140
- Avoid direct calls to `os`
145141
- Use `Pathlib` library instead of `os.path`
146142
- Use `platform.system()` instead of `os.name` and `sys.platform`
147143
- Don't prepend local imports with `tagstudio`, stick to `src`
148144
- Use the `logger` system instead of `print` statements
149145
- Avoid nested f-strings
150-
- Use HTML-like tags inside Qt widgets over stylesheets where possible.
146+
- Use HTML-like tags inside Qt widgets over stylesheets where possible
151147

152148
### Commit and Pull Request Style
153149

@@ -159,7 +155,7 @@ Most of the style guidelines can be checked, fixed, and enforced via Ruff. Older
159155

160156
> [!IMPORTANT]
161157
> Please do not force push if your PR is open for review!
162-
>
158+
>
163159
> Force pushing makes it impossible to discern which changes have already been reviewed and which haven't. This means a reviewer will then have to rereview all the already reviewed code, which is a lot of unnecessary work for reviewers.
164160
165161
> [!TIP]
@@ -172,9 +168,9 @@ Most of the style guidelines can be checked, fixed, and enforced via Ruff. Older
172168
- macOS: 12.0+
173169
- Linux: _Varies_
174170
- Final code must **_NOT:_**
175-
- Contain superfluous or unnecessary logging statements.
176-
- Cause unreasonable slowdowns to the program outside of a progress-indicated task.
177-
- Cause undesirable visual glitches or artifacts on screen.
171+
- Contain superfluous or unnecessary logging statements
172+
- Cause unreasonable slowdowns to the program outside of a progress-indicated task
173+
- Cause undesirable visual glitches or artifacts on screen
178174

179175
## Documentation Guidelines
180176

README.md

Lines changed: 66 additions & 72 deletions
Large diffs are not rendered by default.

docs/assets/built_tag_shrek.png

98.4 KB
Loading

docs/assets/github_header.png

-701 KB
Loading

docs/assets/screenshot.jpg

-851 KB
Binary file not shown.

docs/assets/screenshot.png

1.15 MB
Loading
23.1 KB
Loading

docs/assets/tag_color_selection.png

103 KB
Loading
26.3 KB
Loading

docs/index.md

Lines changed: 20 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -4,33 +4,15 @@ title: Home
44

55
# Welcome to the TagStudio Documentation!
66

7-
!!! warning
8-
This documentation is still a work in progress, and is intended to aide with deconstructing and understanding of the core mechanics of TagStudio and how it operates.
9-
107
![TagStudio Alpha](assets/github_header.png)
118

129
TagStudio is a photo & file organization application with an underlying tag-based system that focuses on giving freedom and flexibility to the user. No proprietary programs or formats, no sea of sidecar files, and no complete upheaval of your filesystem structure.
1310

1411
<figure width="60%" markdown="span">
15-
![TagStudio screenshot](assets/screenshot.jpg)
16-
<figcaption>TagStudio Alpha v9.4.2 running on Windows 10</figcaption>
12+
![TagStudio screenshot](assets/screenshot.png)
13+
<figcaption>TagStudio Alpha v9.5.0 running on macOS Sequoia.</figcaption>
1714
</figure>
1815

19-
## Goals
20-
21-
- To achieve a portable, private, extensible, open-format, and feature-rich system of organizing and rediscovering files.
22-
- To provide powerful methods for organization, notably the concept of tag inheritance, or “taggable tags” _(and in the near future, the combination of composition-based tags)._
23-
- To create an implementation of such a system that is resilient against a user’s actions outside the program (modifying, moving, or renaming files) while also not burdening the user with mandatory sidecar files or requiring them to change their existing file structures and workflows.
24-
- To support a wide range of users spanning across different platforms, multi-user setups, and those with large (several terabyte) libraries.
25-
- To make the darn thing look like nice, too. It’s 2024, not 1994.
26-
27-
## Priorities
28-
29-
1. **The concept.** Even if TagStudio as an application fails, I’d hope that the idea lives on in a superior project. The [goals](#goals) outlined above don’t reference TagStudio once - _TagStudio_ is what references the _goals._
30-
2. **The system.** Frontends and implementations can vary, as they should. The core underlying metadata management system is what should be interoperable between different frontends, programs, and operating systems. A standard implementation for this should settle as development continues. This opens up the doors for improved and varied clients, integration with third-party applications, and more.
31-
3. **The application.** If nothing else, TagStudio the application serves as the first (and so far only) implementation for this system of metadata management. This has the responsibility of doing the idea justice and showing just what’s possible when it comes to user file management.
32-
4. (The name.) I think it’s fine for an app or client, but it doesn’t really make sense for a system or standard. I suppose this will evolve with time...
33-
3416
## Feature Roadmap
3517

3618
The [Feature Roadmap](updates/roadmap.md) lists all of the planned core features for TagStudio to be considered "feature complete" along with estimated release milestones. The development and testing of these features takes priority over all other requested or submitted features unless they are later added to this roadmap. This helps ensure that TagStudio eventually sees a full release and becomes more usable by more people more quickly.
@@ -39,31 +21,29 @@ The [Feature Roadmap](updates/roadmap.md) lists all of the planned core features
3921

4022
### Libraries
4123

42-
- Create libraries/vaults centered around a system directory. Libraries contain a series of entries: the representations of your files combined with metadata fields. Each entry represents a file in your library’s directory, and is linked to its location.
43-
- Address moved, deleted, or otherwise "unlinked" files by using the "Fix Unlinked Entries" option in the Tools menu.
24+
- Create libraries/vaults centered around a system directory. Libraries contain a series of entries: the representations of your files combined with metadata fields. Each entry represents a file in your library’s directory, and is linked to its location.
25+
- Address moved, deleted, or otherwise "unlinked" files by using the "Fix Unlinked Entries" option in the Tools menu.
4426

45-
### Metadata + Tagging
27+
### Tagging + Custom Metadata
4628

47-
- Add metadata to your library entries, including:
48-
- Name, Author, Artist (Single-Line Text Fields)
49-
- Description, Notes (Multiline Text Fields)
50-
- Tags, Meta Tags, Content Tags (Tag Boxes)
51-
- Create rich tags composed of a name, a list of aliases, and a list of “parent tags” - being tags in which these tags inherit values from.
52-
- Copy and paste tags and fields across file entries
53-
- Generate tags from your existing folder structure with the "Folders to Tags" macro (NOTE: these tags do NOT sync with folders after they are created)
29+
- Add custom powerful tags to your library entries
30+
- Add metadata to your library entries, including:
31+
- Name, Author, Artist (Single-Line Text Fields)
32+
- Description, Notes (Multiline Text Fields)
33+
- Create rich tags composed of a name, color, a list of aliases, and a list of “parent tags” - these being tags in which these tags inherit values from.
34+
- Copy and paste tags and fields across file entries
35+
- Automatically organize tags into groups based on parent tags marked as "categories"
36+
- Generate tags from your existing folder structure with the "Folders to Tags" macro (NOTE: these tags do NOT sync with folders after they are created)
5437

5538
### Search
5639

57-
- Search for entries based on tags, ~~metadata~~ (TBA), or filenames/filetypes (using `filename: <query>`).
58-
- Special search conditions for entries that are: `untagged` and `empty`.
40+
- Search for file entries based on tags, file path (`path:`), file types (`filetype:`), and even media types! (`mediatype:`)
41+
- Use and combine boolean operators (`AND`, `OR`, `NOT`) along with parentheses groups, quotation escaping, and underscore substitution to create detailed search queries
42+
- Use special search conditions (`special:untagged` and `special:empty`) to find file entries without tags or fields, respectively
5943

6044
### File Entries
6145

62-
- All\* file types are supported in TagStudio libraries - just not all have dedicated thumbnail support.
63-
- Preview most image file types, animated GIFs, videos, plain text documents, audio files\*\*, Blender projects, and more!
64-
- Open files or file locations by right-clicking on thumbnails and previews and selecting the respective context menu options. You can also click on the preview panel image to open the file, and click the file path label to open its location.
65-
- Delete files from both your library and drive by right-clicking the thumbnail(s) and selecting the "Move to Trash"/"Move to Recycle Bin" option.
66-
67-
> _\* Weird files with no extension or files such as ".\_DS_Store" currently have limited support._
68-
>
69-
> _\*\* Audio playback coming in v9.5_
46+
- Nearly all file types are supported in TagStudio libraries - just not all have dedicated thumbnail support.
47+
- Preview most image file types, animated GIFs, videos, plain text documents, audio files, Blender projects, and more!
48+
- Open files or file locations by right-clicking on thumbnails and previews and selecting the respective context menu options. You can also click on the preview panel image to open the file, and click the file path label to open its location.
49+
- Delete files from both your library and drive by right-clicking the thumbnail(s) and selecting the "Move to Trash"/"Move to Recycle Bin" option.

0 commit comments

Comments
 (0)