mirror-github-bspeice/dtparse
1
0
Fork 0
mirror of https://github.com/bspeice/dtparse synced 2024-11-13 17:38:09 -05:00
Code Issues Releases Wiki Activity
7bb02a7648
dtparse/README.md
Bradlee Speice e54977ee97 Get the README updated with what's needed before 1.0
2018-06-17 23:21:11 -04:00

1.3 KiB
Raw Blame History

dtparse

A dateutil-compatible timestamp parser for Rust

Where it stands

The library works really well at the moment, and passes the vast majority of dateutils parser test suite. This isn't mission-critical ready, but is more than ready for hobbyist projects.

The issues to be resolved before version 1.0:

Functionality:

  1. We don't support weekday parsing. In the Python side this is accomplished via dateutil.relativedelta

  2. Named timezones aren't supported very well. chrono_tz theoretically would provide support, but I'd also like some helper things available (e.g. "EST" is not a named zone in chrono-tz). Explicit time zones (i.e. "00:00:00 -0300") are working as expected.

  3. "Fuzzy" and "Fuzzy with tokens" modes haven't been tested. The code should work, but I need to get the test cases added to the auto-generation suite

Non-functional: This library is intended to be a direct port from Python, and thus the code looks a lot more like Python than it does Rust. There are a ton of TODO comments in the code that need cleaned up, things that could be converted to enums, etc.

In addition, some more documentation would be incredibly helpful. It's, uh, sparse at the moment.