You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/install.md
+16Lines changed: 16 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,6 +12,8 @@ TagStudio has builds for **Windows**, **macOS** _(Apple Silicon & Intel)_, and *
12
12
!!! info "For macOS Users"
13
13
On macOS, you may be met with a message saying "**"TagStudio" can't be opened because Apple cannot check it for malicious software.**" If you encounter this, then you'll need to go to the "Settings" app, navigate to "Privacy & Security", and scroll down to a section that says "**"TagStudio" was blocked from use because it is not from an identified developer.**" Click the "Open Anyway" button to allow TagStudio to run. You should only have to do this once after downloading the application.
14
14
15
+
---
16
+
15
17
### Package Managers
16
18
17
19
<!-- prettier-ignore -->
@@ -46,6 +48,8 @@ pip install .
46
48
47
49
TagStudio can now be launched via the `tagstudio` command in your terminal.
48
50
51
+
---
52
+
49
53
### Linux
50
54
51
55
Some external dependencies are required for TagStudio to execute. Below is a table of known packages that will be necessary.
@@ -197,6 +201,8 @@ Finally, `inputs` can be used in a module to add the package to your packages li
197
201
198
202
Don't forget to rebuild!
199
203
204
+
---
205
+
200
206
## Creating a Development Environment
201
207
202
208
If you wish to develop for TagStudio, you'll need to create a development environment by installing the required dependencies. You have a number of options depending on your level of experience and familiarly with existing Python toolchains.
@@ -219,6 +225,8 @@ If you already have Python installed on your system, you can check the version b
219
225
python --version
220
226
```
221
227
228
+
---
229
+
222
230
#### Installing with pyenv
223
231
224
232
If you choose to install Python using pyenv, please refer to the following instructions:
@@ -227,6 +235,8 @@ If you choose to install Python using pyenv, please refer to the following instr
227
235
2. Install the appropriate Python version with pyenv by running `pyenv install 3.12` (This will **not** mess with your existing Python installation).
228
236
3. Navigate to the repository root folder in your terminal and run `pyenv local 3.12`. You could alternatively use `pyenv shell 3.12` or `pyenv global 3.12` instead to set the Python version for the current terminal session or the entire system respectively, however using `local` is recommended.
229
237
238
+
---
239
+
230
240
### Installing Dependencies
231
241
232
242
To install the required dependencies, you can use a dependency manager such as [uv](https://docs.astral.sh/uv) or [Poetry 2.0](https://python-poetry.org). Alternatively you can create a virtual environment and manually install the dependencies yourself.
@@ -239,6 +249,8 @@ If using [uv](https://docs.astral.sh/uv), you can install the dependencies for T
239
249
uv pip install -e .[dev]
240
250
```
241
251
252
+
---
253
+
242
254
#### Installing with Poetry
243
255
244
256
If using [Poetry](https://python-poetry.org), you can install the dependencies for TagStudio with the following command:
@@ -247,6 +259,8 @@ If using [Poetry](https://python-poetry.org), you can install the dependencies f
247
259
poetry install --with dev
248
260
```
249
261
262
+
---
263
+
250
264
#### Installing with Nix
251
265
252
266
If using [Nix](https://nixos.org/), there is a development environment already provided in the [flake](https://wiki.nixos.org/wiki/Flakes) that is accessible with the following command:
@@ -272,6 +286,8 @@ cat .envrc # You are checking them, right?
272
286
direnv allow
273
287
```
274
288
289
+
---
290
+
275
291
#### Manual Installation
276
292
277
293
If you choose to manually set up a virtual environment and install dependencies instead of using a dependency manager, please refer to the following instructions:
0 commit comments