Merge pull request #136 from Eve-ning/1.0.0

Update to 1.0.0

Author: Eve-ning

.github/workflows/pytest.yml

@@ -15,7 +15,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        python-version: ['3.9', '3.10', '3.11']
+        python-version: ['3.10', '3.11', '3.12', '3.13']
         test-type: ['unit_tests', 'algorithm_tests']
 
     steps:

.pre-commit-config.yaml

@@ -25,8 +25,7 @@ retrieve the underlying `DataFrame` via the `.df` property on many reamber class
 
 # Status
 
-This is in alpha, names and references will change without notice.
-We highly recommended to fix version in requirements.
+This is now in 1.0.0, though I don't plan to actively develop it further.
 
 ## For Developers, By Developers
 
@@ -36,9 +35,3 @@ The best way to learn is to relate it to something that you're familiar with.
 That's why I'm making a library that allows you to tamper with your favorite
 games, and learn on the way.
 
-# Migrating to >v0.1.1 Releases
-
-Migrating to `>0.1.1` means spending time updating **a lot** of names.
-
-Major changes in `0.1.1` include many differences in naming. 
-Only update it if you don't plan mind spending time refactoring.

README.md

@@ -4,6 +4,10 @@ Note: In the future, the minor changelog will be moved to
 the [GitHub Release page](https://github.com/Eve-ning/reamberPy/releases).
 Major changes will still be documented here.
 
+## 1.0.0
+
+- No significant change here, just finalizing the library
+
 ## 0.2.1
 
 - Update documentation to use **JetBrains' WriterSide**.

Writerside/topics/info/ChangeLog.md

@@ -1 +1 @@
-{"entities":{"pages":{"index":{"id":"index","title":"Reamber(Py)","url":"index_md.html","level":0,"tabIndex":0},"fe8f2838_1718":{"id":"fe8f2838_1718","title":"About","level":0,"pages":["GettingStarted","Conventions","ChangeLog","About"],"tabIndex":1},"GettingStarted":{"id":"GettingStarted","title":"Getting Started","url":"gettingstarted.html","level":1,"parentId":"fe8f2838_1718","tabIndex":0},"Conventions":{"id":"Conventions","title":"Conventions","url":"conventions.html","level":1,"parentId":"fe8f2838_1718","tabIndex":1},"ChangeLog":{"id":"ChangeLog","title":"Changelog","url":"changelog.html","level":1,"parentId":"fe8f2838_1718","tabIndex":2},"About":{"id":"About","title":"About ReamberPy","url":"about.html","level":1,"parentId":"fe8f2838_1718","tabIndex":3},"fe8f2838_1723":{"id":"fe8f2838_1723","title":"Learn","level":0,"pages":["WorkingWithMaps","Stacking","BuildingBlocks","Basics"],"tabIndex":2},"WorkingWithMaps":{"id":"WorkingWithMaps","title":"Working with Maps","url":"workingwithmaps.html","level":1,"parentId":"fe8f2838_1723","tabIndex":0},"Stacking":{"id":"Stacking","title":"Stacking","url":"stacking.html","level":1,"parentId":"fe8f2838_1723","tabIndex":1},"BuildingBlocks":{"id":"BuildingBlocks","title":"Building Blocks of ReamberPy","url":"buildingblocks.html","level":1,"parentId":"fe8f2838_1723","tabIndex":2},"Basics":{"id":"Basics","title":"Basics of ReamberPy","url":"basics.html","level":1,"parentId":"fe8f2838_1723","tabIndex":3},"fe8f2838_1728":{"id":"fe8f2838_1728","title":"Objects","level":0,"pages":["SM","Quaver","Osu","O2Jam","BMS","fe8f2838_1734","fe8f2838_1746","fe8f2838_1750"],"tabIndex":3},"SM":{"id":"SM","title":"StepMania","url":"sm.html","level":1,"parentId":"fe8f2838_1728","tabIndex":0},"Quaver":{"id":"Quaver","title":"Quaver","url":"quaver.html","level":1,"parentId":"fe8f2838_1728","tabIndex":1},"Osu":{"id":"Osu","title":"Osu!","url":"osu.html","level":1,"parentId":"fe8f2838_1728","tabIndex":2},"O2Jam":{"id":"O2Jam","title":"O2Jam","url":"o2jam.html","level":1,"parentId":"fe8f2838_1728","tabIndex":3},"BMS":{"id":"BMS","title":"BMS","url":"bms.html","level":1,"parentId":"fe8f2838_1728","tabIndex":4},"fe8f2838_1734":{"id":"fe8f2838_1734","title":"Algorithms","level":1,"parentId":"fe8f2838_1728","pages":["SvNormalize","ScrollSpeed","PlayFieldPattern","PlayField","Pattern","FullLN","DominantBpm","Conversions","fe8f2838_1743"],"tabIndex":5},"SvNormalize":{"id":"SvNormalize","title":"SV Normalize","url":"svnormalize.html","level":2,"parentId":"fe8f2838_1734","tabIndex":0},"ScrollSpeed":{"id":"ScrollSpeed","title":"Scroll Speed","url":"scrollspeed.html","level":2,"parentId":"fe8f2838_1734","tabIndex":1},"PlayFieldPattern":{"id":"PlayFieldPattern","title":"Play Field Imaging with Patterns","url":"playfieldpattern.html","level":2,"parentId":"fe8f2838_1734","tabIndex":2},"PlayField":{"id":"PlayField","title":"Play Field","url":"playfield.html","level":2,"parentId":"fe8f2838_1734","tabIndex":3},"Pattern":{"id":"Pattern","title":"Patterns","url":"pattern.html","level":2,"parentId":"fe8f2838_1734","tabIndex":4},"FullLN":{"id":"FullLN","title":"Full LN","url":"fullln.html","level":2,"parentId":"fe8f2838_1734","tabIndex":5},"DominantBpm":{"id":"DominantBpm","title":"Dominant BPM","url":"dominantbpm.html","level":2,"parentId":"fe8f2838_1734","tabIndex":6},"Conversions":{"id":"Conversions","title":"Conversions","url":"conversions.html","level":2,"parentId":"fe8f2838_1734","tabIndex":7},"fe8f2838_1743":{"id":"fe8f2838_1743","title":"osu","level":2,"parentId":"fe8f2838_1734","pages":["ParseReplay","HitsoundCopy"],"tabIndex":8},"ParseReplay":{"id":"ParseReplay","title":"osu! Parse Replay","url":"parsereplay.html","level":3,"parentId":"fe8f2838_1743","tabIndex":0},"HitsoundCopy":{"id":"HitsoundCopy","title":"osu! Hit Sound Copy","url":"hitsoundcopy.html","level":3,"parentId":"fe8f2838_1743","tabIndex":1},"fe8f2838_1746":{"id":"fe8f2838_1746","title":"Base Objects","level":1,"parentId":"fe8f2838_1728","pages":["MapSet","Map","BpmHitHold"],"tabIndex":6},"MapSet":{"id":"MapSet","title":"MapSet","url":"mapset.html","level":2,"parentId":"fe8f2838_1746","tabIndex":0},"Map":{"id":"Map","title":"Map","url":"map.html","level":2,"parentId":"fe8f2838_1746","tabIndex":1},"BpmHitHold":{"id":"BpmHitHold","title":"Bpm, Hit and Hold","url":"bpmhithold.html","level":2,"parentId":"fe8f2838_1746","tabIndex":2},"fe8f2838_1750":{"id":"fe8f2838_1750","title":"BMS","level":1,"parentId":"fe8f2838_1728","pages":["Channel"],"tabIndex":7},"Channel":{"id":"Channel","title":"BMS Channel Configurations","url":"channel.html","level":2,"parentId":"fe8f2838_1750","tabIndex":0},"fe8f2838_1752":{"id":"fe8f2838_1752","title":"Dev Info","level":0,"pages":["TypeHinting","Props","DevInfo"],"tabIndex":4},"TypeHinting":{"id":"TypeHinting","title":"Type Hinting Pandas Columns","url":"typehinting.html","level":1,"parentId":"fe8f2838_1752","tabIndex":0},"Props":{"id":"Props","title":"Generating Properties on the Fly","url":"props.html","level":1,"parentId":"fe8f2838_1752","tabIndex":1},"DevInfo":{"id":"DevInfo","title":"Development Info","url":"devinfo.html","level":1,"parentId":"fe8f2838_1752","tabIndex":2}}},"topLevelIds":["index","fe8f2838_1718","fe8f2838_1723","fe8f2838_1728","fe8f2838_1752"]}
+{"entities":{"pages":{"index":{"id":"index","title":"Reamber(Py)","url":"index_md.html","level":0,"tabIndex":0},"-kolqb2_3":{"id":"-kolqb2_3","title":"About","level":0,"pages":["GettingStarted","Conventions","ChangeLog","About"],"tabIndex":1},"GettingStarted":{"id":"GettingStarted","title":"Getting Started","url":"gettingstarted.html","level":1,"parentId":"-kolqb2_3","tabIndex":0},"Conventions":{"id":"Conventions","title":"Conventions","url":"conventions.html","level":1,"parentId":"-kolqb2_3","tabIndex":1},"ChangeLog":{"id":"ChangeLog","title":"Changelog","url":"changelog.html","level":1,"parentId":"-kolqb2_3","tabIndex":2},"About":{"id":"About","title":"About ReamberPy","url":"about.html","level":1,"parentId":"-kolqb2_3","tabIndex":3},"-kolqb2_4":{"id":"-kolqb2_4","title":"Learn","level":0,"pages":["WorkingWithMaps","Stacking","BuildingBlocks","Basics"],"tabIndex":2},"WorkingWithMaps":{"id":"WorkingWithMaps","title":"Working with Maps","url":"workingwithmaps.html","level":1,"parentId":"-kolqb2_4","tabIndex":0},"Stacking":{"id":"Stacking","title":"Stacking","url":"stacking.html","level":1,"parentId":"-kolqb2_4","tabIndex":1},"BuildingBlocks":{"id":"BuildingBlocks","title":"Building Blocks of ReamberPy","url":"buildingblocks.html","level":1,"parentId":"-kolqb2_4","tabIndex":2},"Basics":{"id":"Basics","title":"Basics of ReamberPy","url":"basics.html","level":1,"parentId":"-kolqb2_4","tabIndex":3},"-kolqb2_5":{"id":"-kolqb2_5","title":"Objects","level":0,"pages":["SM","Quaver","Osu","O2Jam","BMS","-kolqb2_20","-kolqb2_21","-kolqb2_22"],"tabIndex":3},"SM":{"id":"SM","title":"StepMania","url":"sm.html","level":1,"parentId":"-kolqb2_5","tabIndex":0},"Quaver":{"id":"Quaver","title":"Quaver","url":"quaver.html","level":1,"parentId":"-kolqb2_5","tabIndex":1},"Osu":{"id":"Osu","title":"Osu!","url":"osu.html","level":1,"parentId":"-kolqb2_5","tabIndex":2},"O2Jam":{"id":"O2Jam","title":"O2Jam","url":"o2jam.html","level":1,"parentId":"-kolqb2_5","tabIndex":3},"BMS":{"id":"BMS","title":"BMS","url":"bms.html","level":1,"parentId":"-kolqb2_5","tabIndex":4},"-kolqb2_20":{"id":"-kolqb2_20","title":"Algorithms","level":1,"parentId":"-kolqb2_5","pages":["SvNormalize","ScrollSpeed","PlayFieldPattern","PlayField","Pattern","FullLN","DominantBpm","Conversions","-kolqb2_31"],"tabIndex":5},"SvNormalize":{"id":"SvNormalize","title":"SV Normalize","url":"svnormalize.html","level":2,"parentId":"-kolqb2_20","tabIndex":0},"ScrollSpeed":{"id":"ScrollSpeed","title":"Scroll Speed","url":"scrollspeed.html","level":2,"parentId":"-kolqb2_20","tabIndex":1},"PlayFieldPattern":{"id":"PlayFieldPattern","title":"Play Field Imaging with Patterns","url":"playfieldpattern.html","level":2,"parentId":"-kolqb2_20","tabIndex":2},"PlayField":{"id":"PlayField","title":"Play Field","url":"playfield.html","level":2,"parentId":"-kolqb2_20","tabIndex":3},"Pattern":{"id":"Pattern","title":"Patterns","url":"pattern.html","level":2,"parentId":"-kolqb2_20","tabIndex":4},"FullLN":{"id":"FullLN","title":"Full LN","url":"fullln.html","level":2,"parentId":"-kolqb2_20","tabIndex":5},"DominantBpm":{"id":"DominantBpm","title":"Dominant BPM","url":"dominantbpm.html","level":2,"parentId":"-kolqb2_20","tabIndex":6},"Conversions":{"id":"Conversions","title":"Conversions","url":"conversions.html","level":2,"parentId":"-kolqb2_20","tabIndex":7},"-kolqb2_31":{"id":"-kolqb2_31","title":"osu","level":2,"parentId":"-kolqb2_20","pages":["ParseReplay","HitsoundCopy"],"tabIndex":8},"ParseReplay":{"id":"ParseReplay","title":"osu! Parse Replay","url":"parsereplay.html","level":3,"parentId":"-kolqb2_31","tabIndex":0},"HitsoundCopy":{"id":"HitsoundCopy","title":"osu! Hit Sound Copy","url":"hitsoundcopy.html","level":3,"parentId":"-kolqb2_31","tabIndex":1},"-kolqb2_21":{"id":"-kolqb2_21","title":"Base Objects","level":1,"parentId":"-kolqb2_5","pages":["MapSet","Map","BpmHitHold"],"tabIndex":6},"MapSet":{"id":"MapSet","title":"MapSet","url":"mapset.html","level":2,"parentId":"-kolqb2_21","tabIndex":0},"Map":{"id":"Map","title":"Map","url":"map.html","level":2,"parentId":"-kolqb2_21","tabIndex":1},"BpmHitHold":{"id":"BpmHitHold","title":"Bpm, Hit and Hold","url":"bpmhithold.html","level":2,"parentId":"-kolqb2_21","tabIndex":2},"-kolqb2_22":{"id":"-kolqb2_22","title":"BMS","level":1,"parentId":"-kolqb2_5","pages":["Channel"],"tabIndex":7},"Channel":{"id":"Channel","title":"BMS Channel Configurations","url":"channel.html","level":2,"parentId":"-kolqb2_22","tabIndex":0},"-kolqb2_6":{"id":"-kolqb2_6","title":"Dev Info","level":0,"pages":["TypeHinting","Props","DevInfo"],"tabIndex":4},"TypeHinting":{"id":"TypeHinting","title":"Type Hinting Pandas Columns","url":"typehinting.html","level":1,"parentId":"-kolqb2_6","tabIndex":0},"Props":{"id":"Props","title":"Generating Properties on the Fly","url":"props.html","level":1,"parentId":"-kolqb2_6","tabIndex":1},"DevInfo":{"id":"DevInfo","title":"Development Info","url":"devinfo.html","level":1,"parentId":"-kolqb2_6","tabIndex":2}}},"topLevelIds":["index","-kolqb2_3","-kolqb2_4","-kolqb2_5","-kolqb2_6"]}