Module: repo_manager
Utility functions for uploading/downloading repositories to/from Arweave. Each repository contains multiple artifact files.
Repository files (artifacts) are logically grouped together via a Manifest file, which maps individual transaction data to named files.
When uploading a repo directory, a version mapping dictionary file is expected to be provided. The mapping should contain a map of filename to version tag. The version tag is useful if a specific version of a file is meant to be downloaded. If no mapping is specified, version will be an empty string.
NotFinalizedException
RepoManager
Bases: FileManager
Source code in src/ritual_arweave/repo_manager.py
49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 |
|
download_artifact_file(repo_id, file_name, version=None, force_download=False, base_path='.')
Downloads a specific artifact from Arweave.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
repo_id |
Union[RepoId, str]
|
id of the repo, if provided as a string, the
format must be of the form |
required |
file_name |
str
|
name of artifact |
required |
version |
Optional[str]
|
Version of file. Defaults to None. If none specified, will fetch the latest version. |
None
|
force_download |
bool
|
If True, will download file even if it already exists at that path. Defaults to False. |
False
|
base_path |
str
|
path to download file to. Defaults to "". |
'.'
|
Raises:
Type | Description |
---|---|
ValueError
|
if wallet file path is not specified or wallet file is not found. |
Returns:
Name | Type | Description |
---|---|---|
str |
str
|
path of downloaded file |
Source code in src/ritual_arweave/repo_manager.py
50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 |
|
download_repo(repo_id, base_path='.', force_download=False)
Downloads a repo from Arweave to a given directory.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
repo_id |
Union[RepoId, str]
|
id of the repo, if provided as a string, the
format must be of the form |
required |
base_path |
str
|
Directory to download to. Defaults to current directory. |
'.'
|
force_download |
bool
|
If True, will download files even if they already exist. Defaults to False. |
False
|
Raises:
Type | Description |
---|---|
ValueError
|
if wallet file path is not specified or wallet file is not found. |
ValueError
|
if matching repo manifest not found |
NotFinalizedException
|
if the manifest is still being mined |
Returns:
Type | Description |
---|---|
list[str]
|
list[str]: downloaded file paths |
Source code in src/ritual_arweave/repo_manager.py
290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 |
|
upload_repo(name, path, version_mapping_file=None, version_mapping=None, extra_file_tags=None)
Uploads a repo directory to Arweave. For every repository upload, a manifest mapping is created.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
name |
str
|
Name of the repository. Once uploaded, the repo will be
accessible via the repo Id: |
required |
path |
str
|
Path to the directory containing the artifacts. |
required |
version_mapping_file |
str
|
Path to a json dict file mapping file names to specific versions. If a specific mapping is found, the File-Version attribute is tagged with the value. This is to facilitate uploading and downloading version specific files. |
None
|
version_mapping |
dict[str, str]
|
Dictionary mapping file names to specific versions. If a specific mapping is found, the File-Version attribute is tagged with the value. This is to facilitate uploading and downloading version specific files. If provided, this will override the version_file. |
None
|
extra_file_tags |
dict[str, Tags]
|
Dictionary mapping file names to additional tags to be added to the file. This is useful for adding additional metadata to each file. |
None
|
Raises:
Type | Description |
---|---|
ValueError
|
if wallet file path is not specified or wallet file is not found. |
Returns:
Name | Type | Description |
---|---|---|
UploadRepoResult |
UploadRepoResult
|
Result of the upload containing repo_id, transaction_id, |
UploadRepoResult
|
and manifest_url. |
Source code in src/ritual_arweave/repo_manager.py
167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 |
|