Skip to content

Commit 3778fd4

Browse files
authored
Improving the basic_usage_examples.py
* Removing some old connection hacks from basic_usage_examples.py, and improving comments now that `get_davclient()` is in use connection parameters should be passed through environment or through a configuration file. * Rearrange basic_usage_examples.py to be easier to follow, having the functions appear in order of usage helps read the example code * Be more verbose during execution * Bugfix, use the calendar name passed in and not the hardcoded value Fixes #533 #534 Signed-off-by: David Greaves <david@dgreaves.com> Signed-off-by: Tobias Brox <tobias@redpill-linpro.com>
1 parent d333c00 commit 3778fd4

3 files changed

Lines changed: 197 additions & 173 deletions

File tree

CHANGELOG.md

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,14 @@
11
# Changelog
22

3-
The format of this file should adhere to [Keep a Changelog](https://keepachangelog.com/en/1.1.0/).
3+
## IMPORTANT - "flapping" changeset!
4+
5+
In 2.0.0 I dropped the dependency on the requests library as the project is stagnant and adopted niquests, a fork of the requests library. It's a small change, and three github issues could be closed just by doing this switch. In addition niquests supports HTTP/2 and is one possible way forward for implementing async support. However, the change has proven controversial, shortly after releasing 2.0 I had to revert back to requests and release 2.0.1. Right after releasing 2.0.1, I reverted again so that the master branch is using niquests.
6+
7+
My plan now is to keep doing dual releases while maintaining the 2.x-series - one with niquests and one with requests. You are encouraged to make an informed decision on weather you are most comfortable with the stable but stagnant requests, or the niquests fork and choose your version accordingly. When I'm starting to work on 3.0 (which will support async requests), I will think deeply about this and either choose niquests, httpx, or (it's always possible to hope!) requests 3.0. **Your opinion is valuable for me**. Feel free to comment on https://github.com/python-caldav/caldav/issues/457, https://github.com/python-caldav/caldav/issues/530 or https://github.com/jawah/niquests/issues/267 if you have a github account, and if not you can reach out at python-http@plann.no
8+
9+
## Versioning and the changelog
10+
11+
The format of this file should adhere more or less to [Keep a Changelog](https://keepachangelog.com/en/1.1.0/). I sometimes throw in some extra sections though for the documentation changes and test framework changes (perhaps I should rather make separate CHANGELOGs in the tests and doc folders?)
412

513
Changelogs prior to v1.2 follows other formats and are available in the v1.2-release.
614

@@ -85,6 +93,10 @@ If you disagree with any of this, please raise an issue and I'll consider if it'
8593
* Added test code for some observed problem that I couldn't reproduce - https://github.com/python-caldav/caldav/issues/397 - https://github.com/python-caldav/caldav/pull/521
8694
* Wrote up some test code to improve code coverage - https://github.com/python-caldav/caldav/issues/93 - https://github.com/python-caldav/caldav/pull/526
8795

96+
### Time spent
97+
98+
The maintainer has spent around 49 hours totally since 1.6. That is a bit above estimate. For one thing, the configuration file change was not in the original road map for 2.0.
99+
88100
## [1.6.0] - 2025-05-30
89101

90102
This will be the last minor release before 2.0. The scheduling support has been fixed up a bit, and saving a single recurrence does what it should do, rather than messing up the whole series.

docs/source/configfile.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ If a section ``contains`` different other sections, it's efficiently a collectio
3939
Simple example
4040
==============
4141

42-
.. code-block: yaml
42+
.. code-block:: yaml
4343
4444
---
4545
default:

0 commit comments

Comments
 (0)