Merge pull request #101 from Eve-ning/0.1.7

0.1.7

Author: Eve-ning

.github/workflows/python-publish.yml renamed to .github/workflows/pypi-publish.yml

@@ -6,7 +6,7 @@
 # separate terms of service, privacy policy, and support
 # documentation.
 
-name: Upload Python Package
+name: Upload Python Package to PyPi
 
 on:
   release:

.github/workflows/python-package.yml renamed to .github/workflows/pytest.yml

@@ -1,7 +1,7 @@
 # This workflow will install Python dependencies, run tests and lint with a variety of Python versions
 # For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions
 
-name: Python package
+name: Python Tests
 
 on:
   push:
@@ -16,6 +16,7 @@ jobs:
       fail-fast: false
       matrix:
         python-version: ["3.7", "3.8", "3.9"]
+        test-type: ["unit_tests", "algorithm_tests"]
 
     steps:
 
@@ -42,13 +43,18 @@ jobs:
         # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
         flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
 
-    - name: Test with pytest w/ coverage
-      run: |
-        pytest --cov=. --cov-report=xml:.coverage.xml
+    - name: Test with pytest
+      if: ${{ matrix.python-version }} != "3.7"
+      run: pytest tests/${{ matrix.test-type }}
+
+    - name: Test with pytest w/ coverage for 3.7
+      if: ${{ matrix.python-version }} == "3.7"
+      run: pytest tests/${{ matrix.test-type }} --cov=. --cov-report=xml:${{ matrix.test-type }}.xml
 
-    - name: Upload coverage reports to Codecov for Py 3.7
+    - name: Upload coverage reports to Codecov for 3.7
       if: ${{ matrix.python-version }} == "3.7"
       uses: codecov/[email protected]
       with:
-        files: .coverage.xml
-        verbose: true
+        files: ${{ matrix.test-type }}.xml
+        verbose: true
+        fail_ci_if_error: true

README.md

@@ -1,12 +1,16 @@
-# [:blue_book: Wiki](https://eve-ning.github.io/reamberPy/index.html) & [Getting Started](https://eve-ning.github.io/reamberPy/info/GettingStarted.html)
-------
+![license](https://img.shields.io/github/license/Eve-ning/reamberPy)
+![dls](https://img.shields.io/pypi/dm/reamber)
+![codecov-coverage](https://img.shields.io/codecov/c/github/Eve-ning/reamberPy)
+![codefactor](https://img.shields.io/codefactor/grade/github/Eve-ning/reamberPy)
+![version](https://img.shields.io/pypi/v/reamber)
+
 # Reamber (Py) 
 
-**Status: Development in Progress**
+[:blue_book: Wiki](https://eve-ning.github.io/reamberPy/index.html) & [Getting Started](https://eve-ning.github.io/reamberPy/info/GettingStarted.html)
 
 **Supports Python `3.7`, `3.8`, `3.9`**
 
-`pip install reamber==0.1.6`
+`pip install reamber`
 
 ------
 
@@ -16,21 +20,21 @@ such as offset, column, bpm, etc.
 This doesn't provide complex algorithms, only the base dataclasses and helpful basic
 algorithms
 
-# Migrating to >v0.1.1 Releases
+## 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.
 
-# For Developers
+## For Developers
 
 Note that this is still in alpha stage, means a lot of things aren't settled down
 yet. In other words, many function names and references will change without notice.
 
 It is recommended to only build scratch/temp files if you want to utilize this library
 
-# Motivation
+## Motivation
 
 A growing amount of osu!mania players are becoming interested in programming.
 The best way to learn is to relate it to something that you're familiar with.

docs/.buildinfo

@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: bae5b29be5f0ce67947980e00b39fc25
+config: 8a222a01cdef7c1db7be66e64f9b0c48
 tags: 645f666f9bcd5a90fca523b33c5a78b7

docs/_sources/devInfo/DevInfo.md.txt

@@ -87,9 +87,11 @@ For each map, it has an ``objs`` dictionary of ``TimedList`` children. This is t
 ```python
 from reamber.base.lists.notes.HitList import HitList
 from reamber.base.lists.notes.HoldList import HoldList
-from reamber.base.lists.BpmList import BpmList 
+from reamber.base.lists.BpmList import BpmList
+
 objs = dict(hits=HitList([]), holds=HoldList([]), bpms=BpmList([]))
 ```
+
 In other words, it always initializes with these classes, but inheriting classes can override ``objs``.
 
 Overriding updates the classes, where it should opt for ``OsuHoldList`` instead of ``HoldList``.

docs/_sources/info/About.md.txt

@@ -23,4 +23,3 @@ control of layout before pushing it out to community development.
 
 The reason for that is because I also aim to learn the ins and outs of developing a *good* package. I believe that I
 learn more of the whys and hows by failing.
-

docs/_sources/info/ChangeLog.md.txt

@@ -6,12 +6,14 @@
 
 - Refactored many parts of the package to make it more maintainable.
   - Discontinued support for SV Package
+
 - Added CI/CD
 - Improved Testing 
 - Improved Documentation
 - Simplify Replay Error parsing
   - Errors are calculated from the minimum distance instead of simulation of play
   - Wrap returns in Dataclasses to improve structuring
+
 - _Honestly too many things I've fixed_
 
 ## 0.1.5
@@ -89,6 +91,7 @@ in the GitHub Release.
 - Convert all ``Hold`` classes to have a separate ``HoldTail`` class.
     - All ``Hold`` classes now have to initialize with ``_length`` instead of ``length``. However, length is still an
       accessible property
+
 - Drop ``Obj`` Suffix for most classes
 - Deprecate ``analysis`` package for in-built base class functions
 - Create ``plot`` package for plotting only

docs/_sources/learn/Basics.md.txt

@@ -58,6 +58,7 @@ Building Blocks of ReamberPy <BuildingBlocks>
 Working with Maps <WorkingWithMaps>
 Stacking <Stacking>
 Map Conversions <Conversions>
+Full LN Conversion <FullLN>
 Pattern Finding <Pattern>
 Play Field Image Generation <PlayField>
 Play Field Imaging for Patterns <PlayFieldPattern>

docs/_sources/learn/FullLN.md.txt

@@ -0,0 +1,33 @@
+# Full LN
+
+## Usage 
+
+To convert a map to a Full LN:
+
+```py
+from reamber.algorithms.generate import full_ln
+from reamber.osu.OsuMap import OsuMap
+
+osu = OsuMap.read_file("my_map.osu")
+osu2 = full_ln(osu, gap=150, ln_as_hit_thres=100)
+osu2.write_file("new_map.osu")
+```
+
+> This works with other map types. It doesn't work with `MapSet`s
+
+## Params
+
+- `gap`: Gap between an LN Tail and the next note.
+- `ln_as_hit_thres`: Smallest LN length before it's converted to a hit.
+
+For example:
+
+- If the distance between 2 notes is 250ms
+- The `gap` is 150ms
+- There will be a 100ms LN rendered.
+
+
+- If the distance between 2 notes is 249ms
+- The `gap` is 150ms
+- There won't be a 99ms LN rendered if `ln_as_hit_thres=100`. Instead, a `Hit` will be rendered.
+

docs/_static/documentation_options.js

@@ -1,6 +1,6 @@
 var DOCUMENTATION_OPTIONS = {
     URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
-    VERSION: '0.1.6',
+    VERSION: '0.1.7',
     LANGUAGE: 'None',
     COLLAPSE_INDEX: false,
     BUILDER: 'html',