Skip to content

Commit

Permalink
doc: update changes
Browse files Browse the repository at this point in the history
  • Loading branch information
yuhui committed Dec 25, 2024
1 parent fbcc21b commit ffe2c48
Show file tree
Hide file tree
Showing 2 changed files with 69 additions and 29 deletions.
29 changes: 0 additions & 29 deletions CHANGELOG.md

This file was deleted.

69 changes: 69 additions & 0 deletions CHANGELOG.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
Changelog
=========

[2.0.1] - 2024-12-26
--------------------

Changed
^^^^^^^

- Updated minimum Python version to v3.11.

[2.0.0] - 2024-12-26
--------------------

**Alert!** This version was yanked because it requires an incorrect version of Python.

Added
^^^^^

- Add type hints for input arguments and output responses.
- Type check performed by typeguard_.
- Add packages: ``requests-cache``, ``typeguard``, ``types-requests``.

.. _typeguard: https://typeguard.readthedocs.io/en/latest/

Changed
^^^^^^^

- **Breaking:** Require argument names and response keys to use snake_case. This is enforced with ``typeguard``.
- **Breaking:** ``tabledata()``: Remove the argument ``variables``, because SingStat removed it from the endpoint.
- Require minimum Python version to v3.10.

Removed
^^^^^^^

- Remove packages: ``backoff``, ``cachetools``, ``pytz``.

[1.1.0] - 2024-02-02
--------------------

Changed
^^^^^^^

- Commit contributions from @qiujunda92 to interact with SingStat.gov.sg's documented API endpoints as of January 2024.
- Add user-agent in header.
- Update endpoint base path.
- Update ``pytz`` version.
- Update package build to use ``build``.

[1.0.2] - 2020-01-19
--------------------

Changed
^^^^^^^

- Update ``pytest`` requirement.

[1.0.1] - 2019-09-03
--------------------

Changed
^^^^^^^

- Use relative imports.

[1.0.0] - 2019-08-21
--------------------

Initial version to interact with SingStat.gov.sg's documented API endpoints as of August 2019.

0 comments on commit ffe2c48

Please sign in to comment.