Skip to content

Commit b2361a0

Browse files
authored
Export cache config and fix package name in README (#21)
1 parent 74f8ade commit b2361a0

3 files changed

Lines changed: 16 additions & 15 deletions

File tree

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ pip install pybiocfilecache
1717
## Quick Start
1818

1919
```python
20-
from biocfilecache import BiocFileCache
20+
from pybiocfilecache import BiocFileCache
2121

2222
# Initialize cache
2323
cache = BiocFileCache("path/to/cache/directory")
@@ -37,7 +37,7 @@ print(resource.rpath) # Path to cached file
3737
### Configuration
3838

3939
```python
40-
from biocfilecache import BiocFileCache, CacheConfig
40+
from pybiocfilecache import BiocFileCache, CacheConfig
4141
from datetime import timedelta
4242
from pathlib import Path
4343

src/pybiocfilecache/__init__.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,3 +16,4 @@
1616
del version, PackageNotFoundError
1717

1818
from .cache import BiocFileCache
19+
from .config import CacheConfig

src/pybiocfilecache/models.py

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -25,43 +25,43 @@ class Resource(Base):
2525
2626
Attributes:
2727
id:
28-
Auto-incrementing primary key
28+
Auto-incrementing primary key.
2929
3030
rid:
31-
Unique resource identifier (UUID)
31+
Unique resource identifier (UUID).
3232
3333
rname:
34-
User-provided resource name
34+
User-provided resource name.
3535
3636
create_time:
37-
When the resource was first added
37+
When the resource was first added.
3838
3939
access_time:
40-
Last time the resource was accessed
40+
Last time the resource was accessed.
4141
4242
rpath:
43-
Path to the resource in the cache
43+
Path to the resource in the cache.
4444
4545
rtype:
46-
Type of resource (local, web, relative)
46+
Type of resource (local, web, relative).
4747
4848
fpath:
49-
Original file path
49+
Original file path.
5050
5151
last_modified_time:
52-
Last time the resource was modified
52+
Last time the resource was modified.
5353
5454
etag:
55-
Checksum/hash of the resource
55+
Checksum/hash of the resource.
5656
5757
expires:
58-
When the resource should be considered expired
58+
When the resource should be considered expired.
5959
6060
tags:
61-
Optional comma-separated tags for categorization
61+
Optional comma-separated tags for categorization.
6262
6363
size_bytes:
64-
Size of the resource in bytes
64+
Size of the resource in bytes.
6565
"""
6666

6767
__tablename__ = "resource"

0 commit comments

Comments
 (0)