Update readme, fill-in package metadata.
This commit is contained in:
parent
9d023ffda0
commit
33f2b811de
3 changed files with 22 additions and 2 deletions
20
README.md
20
README.md
|
@ -1,8 +1,26 @@
|
||||||
# Radicale SQL storage plugin
|
# Radicale SQL storage plugin
|
||||||
|
|
||||||
|
A storage plugin for [Radicale](https://radicale.org) with some extra features.
|
||||||
|
|
||||||
|
Can automatically generate birthday calendars based on address books.
|
||||||
|
|
||||||
|
## Configuration
|
||||||
|
|
||||||
|
Example
|
||||||
|
|
||||||
|
```ini
|
||||||
|
[storage]
|
||||||
|
type=radicale_sql
|
||||||
|
url=sqlite:///data.db
|
||||||
|
generate_birthday_calendars=False
|
||||||
|
```
|
||||||
|
|
||||||
## TODO
|
## TODO
|
||||||
|
|
||||||
- ensure all database operations run in one transaction
|
- ~~ensure all database operations run in one transaction~~
|
||||||
- implement caching
|
- implement caching
|
||||||
- write unit tests
|
- write unit tests
|
||||||
|
- ~~write integration test~~
|
||||||
|
- extend integration test to include auto-generated collections
|
||||||
- run cleanup of `item_history` and `collection_state` tables
|
- run cleanup of `item_history` and `collection_state` tables
|
||||||
|
- integrate alembic
|
||||||
|
|
3
setup.py
3
setup.py
|
@ -5,5 +5,8 @@ from distutils.core import setup
|
||||||
|
|
||||||
setup(
|
setup(
|
||||||
name='radicale-sql',
|
name='radicale-sql',
|
||||||
|
version='0.1.0',
|
||||||
packages=['radicale_sql'],
|
packages=['radicale_sql'],
|
||||||
|
description='A SQL backed storage for radicale.',
|
||||||
|
url='https://gitea.redxef.at/redxef/radicale-sql',
|
||||||
)
|
)
|
||||||
|
|
|
@ -74,7 +74,6 @@ def test_caldav():
|
||||||
|
|
||||||
calendar0_updates = calendar0.objects_by_sync_token(calendar0_token)
|
calendar0_updates = calendar0.objects_by_sync_token(calendar0_token)
|
||||||
assert len(list(calendar0_updates)) == 1
|
assert len(list(calendar0_updates)) == 1
|
||||||
#assert list(calendar0_updates)[0].is_deleted, list(calendar0_updates)[0]
|
|
||||||
try:
|
try:
|
||||||
list(calendar0_updates)[0].load()
|
list(calendar0_updates)[0].load()
|
||||||
except caldav.lib.error.NotFoundError:
|
except caldav.lib.error.NotFoundError:
|
||||||
|
|
Loading…
Reference in a new issue