Git Product home page Git Product logo

metatyping's People

Contributors

jonathanwamsley avatar nthd3gr33 avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

metatyping's Issues

Populate Duckdb using the processed char_log data

Need to populate the database to allow users to:

  • recommend slowest, inaccurate, and relatively slow words comping to a well established list
  • allow queries to be made to see how the user is progressing
  • can be used for visualizations in the future

The table currently looks like:

CREATE TABLE word_stats(
    word       VARCHAR,
    wpm        INTEGER,
    wpm_space  INTEGER,
    accuracy   BOOLEAN,
    capital    BOOLEAN,
    symbols    BOOLEAN,
    date       DATE

Add a character log

In order to recommend words, the app needs the character, the time it took to type the character, and if it was typed correctly on the first try.

The character log should not record characters that were skipped with the wildcard `.

The format should be character(char), time(float), correctly typed on first try(boolean)

The file should be saved under a logs file as character_log.txt

division by zero when exiting typing app

program exits out with the following:

File "/MetaTyping/meta_typing/application/utilities.py", line 397, in get_wpm return str(sum([int(time) for word, time, accuracy in time_sorted])/len(time_sorted)) ZeroDivisionError: division by zero

To Reproduce
Steps to reproduce the behavior:

  1. Go to Typing and any typing content
  2. Before typing, press esc esc
  3. See error

Expected behavior
returns to menu

Add arrow key line/screen pagination

Add a line/screen navigation feature for typing and reading.

This feature will allow the user to press :
- ➡️ for next screen
- ⬅️ for previous screen
- ⬇️ for next line
- ⬆️ for previous line

This way if there is important/unimportant information, they have the option to fast-track to the content they want.

Note, the typing log does not get overwritten if you go back pages.

Improve Github documentation

Why?
Improve communication within the organization and with all interested parties (including potential users, future contributors, open source enthusiasts, etc.)

How?

  • Refactor docs so that README has less detail; is more of landing page for the org and project
  • Create CONTRIBUTING.md
  • Create VISION.md
  • Create LICENSE.md
  • Do we need a CoC?

Create a SQLite database

We need a way to store information in order to recommend words and see progression over time.

We want a data base that has

word (text
time (real)
before_space (real)
after_space (real)
accuracy (boolean(not sure if there is))
date (text?)

We want to create the data base first. Then worry about populating and query next with other functions.

add a way to help users practice reading ahead while typing

A new feature that forces users to read ahead by hiding the text up to n characters. n can be an input from a user. So for example, if 3 is selected, then 3 character spaces before the cursor is blocked. This forces users to read ahead

Add light and dark themes

Why?

Give users options. Can also reduce power usage. Improves visibility for some users. Some users are also sensitive to bright light.

What?

Add the option in Settings to change themes.

LICENSE.md needs to have <program properties> filled in

Why?

License needs to be filled to be more legit. Lines 634, 635, 655 all need to be filled out.

<one line to give the program's name and a brief idea of what it does.>
Copyright (C) <year>  <name of author>
<program>  Copyright (C) <year>  <name of author>

How?

  • MetaTyping is a productivity application used to speed read and type text from any URL, clipboard or builtin drill.
  • For author, is it the organisation name or my name?
  • year
  • program = MetaTyping with no space I think

Allow a user to select their slowest words using the database

A new way to recommend words to the user based off of averages on their word.

A new menu should be created so the user can select from a word list or all list what their slowest, most inaccurate are. A word breakdown and accumulator drill should be executed to help them.

Other concern:
The words wpm may need to filter out outliers, in case they took a small pause and instead of a normal 100wpm it is 20 for example.

Basic Frontend for Web App

Why?

Having a basic web app version will help with exposure, user testing, funding, and several other areas.

How?

  • Decide on framework (Pyramid, Flask, etc)
  • Create project in GitHub repo (where?)
  • Integrate existing code into web app

Need a script to transform the raw char,time, accuracy log into words for the database

The script will use the char,time, accuracy to return a json file with:

  • cleaned word(str)
    • a word with only lowercase numbers used a the primary key
  • raw word(str)
  • wpm with no space(int)
    • the estimated wpm without the starting or ending space
  • wpm with space(int)
    • the estimated wpm with the starting and ending space
  • accuracy(bool)
    • if all the words were typed correctly, True
  • capitalization(bool)
    • if there was a capital, True
  • symbols(bool)
    • if there was a symbol, True

Each word will only be processed if the cleaned word is within the 10,000 words.

example output.

{'word': 'again',
'raw word': 'again',
'wpm without space': 136.6874613893737,
'wpm with space': 125.99914320709463,
'accuracy': True,
'capitalization': False,
'symbols': False},

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.