|
7 | 7 |
|
8 | 8 | All notable changes to this project will be documented in this file.
|
9 | 9 |
|
| 10 | +## [2.0.0] - 2025-04-08 |
| 11 | + |
| 12 | +### 🚀 Features |
| 13 | + |
| 14 | +- *(cached-endpoint)* Allow for no cache to be assigned |
| 15 | +- *(reports)* Abstract report methods |
| 16 | +- *(config)* Add workspace missing error exception |
| 17 | +- *(sqlite_cache)* Allow for an external engine param |
| 18 | +- *(cache)* Allow for pathlike & strings objects to be passed in |
| 19 | +- *(reports)* Custom invalid extension error |
| 20 | +- *(sqlite_cache)* Allow for an external engine param |
| 21 | +- *(cache)* Allow for pathlike & strings objects to be passed in |
| 22 | +- *(reports)* Custom invalid extension error |
| 23 | +- *(async)* Implement abstract endpoints |
| 24 | +- *(async)* Implement abstract cache |
| 25 | +- *(async)* Implement sqlite cache |
| 26 | +- *(async-tracker)* Implement async tracker endpoint |
| 27 | +- *(async-project)* Implement async project endpoint |
| 28 | +- *(async-client)* Implement async client endpoint |
| 29 | +- *(async-org)* Implement async org endpoint |
| 30 | +- *(async-tag)* Implement async tag endpoint |
| 31 | +- *(async-workspace)* Implement async workspace endpoint |
| 32 | +- *(async-user)* Implement async user endpoint |
| 33 | +- *(async-reports)* Implement async report endpoints |
| 34 | +- *(endpoints)* Implement custom client parameter |
| 35 | + |
| 36 | +### 🐛 Bug Fixes |
| 37 | + |
| 38 | +- *(scripts)* Include scripts directory in pyproject |
| 39 | +- *(tracker)* Body not converting timedeltas correctly |
| 40 | +- *(endpoints)* Remove wrong types |
| 41 | +- Small endpoint & cache changes |
| 42 | +- *(scripts)* Remove cache from utility script |
| 43 | +- Implement basic import fixes |
| 44 | +- *(typing)* Deal with extra mypy warnings |
| 45 | +- *(typing)* Add generic and extra typing checks |
| 46 | +- *(typing)* Add callable typing |
| 47 | +- *(typing)* Remove all implicity re-exports |
| 48 | +- *(async-sqlite-cache)* Make sure entry exists before deleting |
| 49 | +- *(models)* Revert `TogglClass.from_kwargs` changes |
| 50 | + |
| 51 | +### 🚜 Refactor |
| 52 | + |
| 53 | +- *(cache)* [**breaking**] Simplify abstract cache methods |
| 54 | +- *(endpoints)* Use new caching methods |
| 55 | +- *(body)* [**breaking**] Replace ValueError with KeyError |
| 56 | +- *(body)* [**breaking**] Convert BaseBody class into mapping |
| 57 | +- *(body)* [**breaking**] Make verify_endpoint_parameter method private |
| 58 | +- *(user)* [**breaking**] Remove deprecated check_authentication method |
| 59 | +- *(base_endpoint)* [**breaking**] Remove 'workspace_id' parameter |
| 60 | +- *(base_endpoint)* [**breaking**] Remove 'model' property |
| 61 | +- *(base_endpoint)* [**breaking**] Remove 'endpoint' property |
| 62 | +- *(base_endpoint)* [**breaking**] Remove 'method' helper method |
| 63 | +- *(tracker_endpoint)* [**breaking**] Remove typeerror from add method |
| 64 | +- *(tracker)* [**breaking**] Move 'current' method to tracker endpoint |
| 65 | +- *(tracker)* [**breaking**] Move 'collect' method to tracker endpoint |
| 66 | +- *(user)* User actual object for 'get_details' method |
| 67 | +- *(tracker)* [**breaking**] Move 'get' method to tracker endpoint |
| 68 | +- *(user)* [**breaking**] Remove tracker related info and attributes |
| 69 | +- *(endpoints)* Use endpoint property within method |
| 70 | +- *(workspaces)* [**breaking**] Remove deprecated workspace id param |
| 71 | +- *(reports)* [**breaking**] Remove deprecated methods |
| 72 | +- *(trackers)* [**breaking**] Remove start_date parameter from body |
| 73 | +- *(tags)* [**breaking**] Remove deprecated optional type from 'edit' endpoint method |
| 74 | +- *(config)* [**breaking**] Remove deprecated authentication error |
| 75 | +- *(config)* [**breaking**] Togglrc helper function using workspace missing error |
| 76 | +- *(base_cache)* [**breaking**] Remove deprecated value error from missing parent error exception |
| 77 | +- *(reports)* Use invalid extension error for extension exceptions |
| 78 | +- *(reports)* Use invalid extension error for extension exceptions |
| 79 | +- *(reports)* [**breaking**] Move reports module into main folder |
| 80 | +- [**breaking**] Make most modules private |
| 81 | +- [**breaking**] Adjust imports to new directory structure |
| 82 | +- *(scripts)* Remove cache requirement from cleanup utility |
| 83 | +- *(cache)* Update schema generation |
| 84 | +- *(async)* Update __init__ file |
| 85 | +- *(workspace)* [**breaking**] Make workspace module private |
| 86 | +- *(async)* All async endpoints accept client |
| 87 | +- *(exceptions)* Move exceptions into seperate module |
| 88 | +- *(project)* [**breaking**] Convert 'active' param default to a boolean |
| 89 | +- Use a src folder for the library |
| 90 | +- *(typing)* Cast any returns to correct type |
| 91 | +- Update all modules to new ruff rules |
| 92 | +- *(endpoint)* Cast model to generic class |
| 93 | +- *(metadata)* Convert _version.py to __about__.py |
| 94 | + |
| 95 | +### 📚 Documentation |
| 96 | + |
| 97 | +- *(user, tracker)* Split up tracker & user endpoint pages |
| 98 | +- *(user, tracker)* Split up tracker & user endpoint pages |
| 99 | +- *(scripts)* Utility for generating project diagrams |
| 100 | +- Update to project structure |
| 101 | +- Small fixes & config improvements |
| 102 | +- *(async)* Add references for classes |
| 103 | +- *(examples)* Add async example |
| 104 | +- *(examples)* Fix outdated imports |
| 105 | +- *(contributing)* Update contrib docs |
| 106 | +- *(api)* Update diagrams |
| 107 | +- *(mkdocs)* Update configurate for src layout |
| 108 | +- *(api-guide)* Fix bad relative links |
| 109 | +- *(scripts)* Update diagram script to new src layout |
| 110 | +- *(api-guide)* Update diagrams |
| 111 | +- *(contributing)* Update contributing guideline to uv |
| 112 | +- *(installation)* Include aiosqlite in optional dependencies |
| 113 | +- *(mkdocs)* Add inventories to mkdocstrings |
| 114 | + |
| 115 | +### ⚙️ Miscellaneous Tasks |
| 116 | + |
| 117 | +- *(dev-deps)* Add pytest asyncio |
| 118 | +- *(pytest)* Set asyncio mode |
| 119 | +- *(dev-deps)* Added ruff formatter |
| 120 | +- *(dev-deps)* Update mkdocstrings-python dependency |
| 121 | +- *(coverage)* Keep coverage for tests |
| 122 | +- *(tox)* Make sure to install all extras |
| 123 | +- *(actions)* Do not run slow tests on most matrix combos |
| 124 | +- *(pre-commit)* Update ruff & mypy pre-commit |
| 125 | +- *(pre-commit)* Update pre-commit configuration |
| 126 | +- *(git)* Update .gitignore file |
| 127 | +- *(pre-commit)* Add uv to configuration |
| 128 | +- *(ruff)* Refactor configuration |
| 129 | +- *(ruff)* Refactor ruff configuration |
| 130 | +- *(mypy)* Remove unnecessary errors codes from tests |
| 131 | +- *(pre-commit)* Make sure to fix in ruff pre-commit |
| 132 | +- *(ruff)* Ignore ARG code in tests |
| 133 | +- *(tox)* Update tox config to toml format |
| 134 | +- *(actions)* Update actions to use uv |
| 135 | +- *(git-cliff)* Handle ref type as a refactor |
| 136 | +- *(git-cliff)* Add build section to commit parser |
| 137 | +- *(pyproject)* Add keywords section to pyproject.toml |
| 138 | + |
| 139 | +### 🏗 Build |
| 140 | + |
| 141 | +- *(project)* Convert project management to uv |
| 142 | +- *(lint,type-check)* Change target python version |
| 143 | +- *(pre-commit)* Add SQLAlchemy stubs to pre-commit |
| 144 | + |
| 145 | +### 🧪 Testing |
| 146 | + |
| 147 | +- Replace removed methods with alternatives |
| 148 | +- *(async)* Base fixtures setup |
| 149 | +- Tracker factory fixture |
| 150 | +- *(async-sqlite)* All cache functionality |
| 151 | +- Implement generator function fixtures |
| 152 | +- Fix minor issues |
| 153 | +- *(tags)* Tag get method |
| 154 | +- *(org)* Mark organization tests slow |
| 155 | +- *(async)* Set default fixture loop scope |
| 156 | +- 100% test suite usage |
| 157 | +- *(coverage)* Add source folders |
| 158 | +- Adjust tests to new linting rules |
| 159 | +- *(async-trackers)* Use utc timezone with `datetime.now` |
| 160 | +- *(async-trackers)* Add flaky mark on `test_collect_params` |
| 161 | + |
10 | 162 | ## [1.6.0] - 2024-12-19
|
11 | 163 |
|
12 | 164 | ### 🚀 Features
|
|
0 commit comments