blankriot96/pyhb

An ASMR keyboard sound effect CLI package

pyhb's Issues

Contributing ecosystem improvement

This includes:

• Better CONTRIBUTING.md
• Issue creation guide
• More CI/CD

Spacing between letters in typetester is uneven.

The spacing between characters in the typing tester is uneven.

This causes a whole hoard of problems :

• Can't figure out whether there is a space, or uneven spacing
• Typing the wrong character leads to confusion

Some possible solutions :

• Using alternative libraries to handle this (pygame_gui)
• Huge refactor and new strategies for current design - textmanager is currently hard to extend.

Restructuring current `keyboard_sound_effects.py` might be a good idea.

keyboard_sound_effects.py is rather cluttered and not well designed. It uses globals in a bad way and has its own main method making it seem like an independent script (albeit, it could be).

Refactoring `TextManager` class

Refactoring the current TextManager class would be a good idea. Currently this class is used as a convenience utility to group together initialization data and runtime data, but this is against what a class is for.
A class should represent some data,/ represent some kind of object.

Moving to functional approach might be better. Extraction of result calculation is also a priority.

Updating README

The current README file assumes pyhb can still be installed from pypi.org
Some changes to be made:

• Update installation process
• Tabulate commands
• Improve presentation

Branching strategy documentation

Create documentation for branching strategy - BRANCHING.md

Punctuation on the Typing Test breaks

Punctuation for some reason refuses to work, capitalization, any punctuation at all, breaks the application.
Relevant file -> https://github.com/blankRiot96/pyhb/blob/main/pyhb/typing_tester/text_manager.py#L101

Refactor `play` function

The play function within pyhb/cli/commands.py is pretty poorly written. Can be refactored.

Double click required after finishing type test

So when you finish a type test and this is your state:

The problem is that it takes 2 successive clicks on the retry button before you can actually take another typing test
Also, the settings you choose on this state does not carry on to the typing test, ie, it uses the old settings with which you launched the typing test.

Relevant file -> https://github.com/blankRiot96/pyhb/blob/main/pyhb/typing_tester/settings.py#L115

Branching strategy

Currently pyhb only has a main branch which represents the most active stage of the project.

But this has a couple issues, and I believe keeping the changes committed to separate branches, and then merged into main for releases works much better.

Possible branching strategy:

• main branch for releases, dev branch for commits.
• main branch for releases, (typetester, cli) branches for development.
• releases branch for releases, main branch for development.

/bin/bash: line 1: pyhb: command not found

environment
google colab

step

pip install -U pyhb 
!pyhb install-soundpacks

error
/bin/bash: line 1: pyhb: command not found

best regards

Keyboard sound effect plays after release

When you try pyhb start and then choose a sound pack, it doesn't actually play the sound effect until you release the key you are pressing. Now this by itself sounds fabulous and least problematic when typing constantly, but it just feels weird that the sound effect comes only after the key is released instead of immediately playing the sound when the key is pressed like an actual mechanical keyboard would make.

I have tried some things out in the keyboard_sound_effects.py but have failed to come out with any fast and memory efficient results. For example in this line, when changing it to

keyboard.on_pressed(set_release)

This works and now plays the sound immediately when clicking on a key.
But now the problem is that it starts the spam a very annoying sequence of the same sound when holding on to it.
I have made multiple attempts to fix this, such as removing everything related to the global RELEASED varaible, and instead just playing the sound. But this does the same as keyboard.on_pressed and for some reason is even slower
Another attempt was

    global RELEASED
    while True:
        keyboard.on_release(set_release)

        if RELEASED:
            key_pressed = keyboard.read_key()
            if key_pressed in conf_vals:
                if sound_pack == "nk-cream":
                    sound = pygame.mixer.Sound(
                        f"{user_path}/Soundpacks/{sound_pack}/{key_pressed}.wav"
                    )
                else:
...

But now this is incredibly slow and causes an eventual MemoryError every time.

Should `pyhb` be on pypi?

pyhb is essentially an application on its own, it doesn't extend or help Python in any way. There seems to be little to no reason for this to exist on pypi.

Some things to think about:

• Ease of download (alternatives, and requirements)
• Visibility
• Traffic data collection

Tests broken and invalid

Currently, the unittests don't really help. It tests minor things and fails due to improper checking

Creating custom `cli` package

Using click, refactoring the CLI into its own package seems right.