Releases: halworsen/fflogsapi
Releases · halworsen/fflogsapi
v2.1.2
v2.1.1
v2.1.0
- Added support for the new phase data exposed by the API. Seethe official v2 API docs for more information
- Phase information is exposed at the fight level in this client (
FFLogsFight.phases
), not at the report level
- Phase information is exposed at the fight level in this client (
- Fix quotes not being properly escaped in query filters
- This fixes #2
- System temporary directories are now used for query caches
- As a result, the
cache_directory
param on the client is now deprecated
- As a result, the
- Bump cryptography dependency (vulnerability fix)
Full Changelog: v2.0.2...v2.1.0
v2.0.2
v2.0.1
v2.0.0
- Improved docstrings, including docstrings for many subpackages
- Added generated documentation pages. They are available at fflogsapi.readthedocs.io
- Improved package API. It's now possible to import most objects of interest without digging into specific modules
- Fixed some flaky character tests
- Added the
clean_cache
param to the client, which deletes expired caches on client instantiation.- Cache cleaning is enabled by default
Breaking changes:
- Replaced most
fflogsapi.constants
with enums for things like fight difficulty and event types- To migrate to v2, replace all
fflogsapi.constants
imports with the new enums
- To migrate to v2, replace all
- Moved all dataclasses into the
data
package- To migrate to v2, import dataclasses from
fflogsapi.data
- To migrate to v2, import dataclasses from
- Certain client extension method names have been changed.
- Internal
_id
fields and correspondingid()
functions have been replaced with justid
as a property.FFLogsReport.code()
has been removed. If you need the report code, access theFFLogsReport.code
property.
v1.1.0
- Add dataclass return for zone partitions
- A deprecation warning for dict returns has been added to FFLogsZone.partitions
- Add dataclass returns for character ranking information
- Deprecation warnings for dict returns have been added to FFLogsCharacter.encounter_rankings and FFLogsCharacter.zone_rankings
- Add support for phase-related queries to fights
v1.0.1
v1.0.0
- Extended support for report/fight data to cover the vast majority of interesting API endpoints
- Added
compare
andtimeframe
filtering for fight rankings - Add ability to specify the directory in which query caches should be stored
- The new default directory for cached queries is
./fflogs-querycache
- The new default directory for cached queries is
- Added more event type constants
- Added
constants.TIMESTAMP_PRECISION
, which can be used to convert timestamps to seconds - Improved docstrings, including references to the API documentation where relevant
v0.6.0-beta
- Add support for game data
- Remove
character_pages
from the client in favor ofFFLogsGuild.characters
as they are functionally the same, but character pagination through characterData queries is less stable. - Report master data is no longer fetched in batch.