Releases: Eve-ning/reamberPy
v1.0.0
v0.2.1
v0.1.9!
What's Changed
- Fix #118 by @Eve-ning in #119
- Add categorization of replay error note type by @Eve-ning in #120
- Fix issue with parse_replay_error ignoring column by @Eve-ning in #121
- Hotfix parse replay tqdm spam and expose option to turn off tqdm by @Eve-ning in #124
- 0.1.9 by @Eve-ning in #122
Full Changelog: v0.1.8...v0.1.9
v0.1.8!
What's Changed
- Use float for osu! slider tick rate by @IceDynamix in #108
- Updates Replay Parsing Algorithm by @Eve-ning in #111
- Update Project Meta by @Eve-ning in #112
- Removes Inplace Argument in Hitsound Copy
by @Eve-ning in #113 - Implement Scroll Speed Analysis by @Eve-ning in #114
- Move Algorithm doc under reamber instead of learn by @Eve-ning in #115
- Add SV Normalization Algorithm by @Eve-ning in #116
- 0.1.8 by @Eve-ning in #117
New Contributors
- @IceDynamix made their first contribution in #108
Full Changelog: v0.1.7...v0.1.8
v0.1.7!
v0.1.6!
Major (non-breaking) Changes
The main aim for this branch is to improve maintainability in the future, and also support my other project opal
!
- Heavy improvement on documentation
- Less documentation bloat
- More actual useful info!
- Added CI/CD
- Improved testing
Generally, it shouldn't break much... I think?
If something breaks on your end, be sure to add it in Issues.
v0.1.3 Format Fix
Fixes issue with osu TimingPoints being rendered with floats
v0.1.2 Rate Fix
Fixes rates on OsuMap
and Bpm
not changing on rate
Quick Fix on Type Hinting
This fix simply uploads the missing .pyi
on pip install
reamberPy 0.1.0 Overhaul
Cleaner, Faster
As always, the code base is always being improved, and here's a major one.
- Stacking is implemented, it's very important see the docs.
- All method, variable names are now in
snake_case
. - A new back-end architecture, pivoting off
pd.Series
andpd.DataFrame
.- This allows better flexibility and efficiency for you and me.
inplace
is now deprecated.- No more
@dataclass
- No more plural names vs. singular, all are now singular.
Why a separate special release?
This is to inform all users of this library that many things have changed, and unfortunately, lots of function names are going to be changed (for the better).
Most of the actual code names are untouched, just the styling is changed.
What happened to inplace
?
While inplace
may seem to quicken the execution, it usually leads to annoying, weird code, furthermore, it doesn't really guarantee the time-save.
As to not create a burden on the project, I would push this optimization to much later, if even needed.
The difference in execution time should be non-existent.
Dataclasses?
While @dataclass
was an excellent idea for initial releases, it became a burden when I pivoted off the pandas
package, it just wasn't flexible enough and thus I opted for a more fleshed out __init__
and prop
methods.
Plural vs. Singular?
One of the biggest annoyances is dealing with plural names and singular names, to keep it simple and consistent, all names are always singular, unless stated otherwise.
For example .bpms
is now .bpm
, .offsets
is now .offset
in context.
Migration
I may not be able to list out all the changes as... there's 200 over commits, but here are the major ones you will have to take account of.
CamelCase
is nowsnake_case
.- Plural and Singular names, verify them with the IDE.
- Many functions are now properties, meaning
.offset()
is now.offset
. read_file
means to read from a file,read
to read from strings.- Some unpopular algorithms don't work anymore.
inplace
does not exist anymore.- Try use Stacking with
.stack()
, it's a superior version of mutating. It follows syntax inpandas
.