tushar5526/autotype

Autotype on websites that have copy-paste disabled like Moodle, HackerEarth contest etc.

autotype's Issues

Update Readme

Autotype now works on all three platforms (win, linux and mac). Update that in readme

Migrate from Tkinter to PyQT

Migrate to pipenv

Description

Managing python requirements file manually is not a good idea, as it leads to problems down the road. Switch to pipenv https://realpython.com/pipenv-guide/

Add the black formatter GitHub Action

Add the black formatter GitHub Action

Overview

Currently, there is no Code Formatter used in Autotype, Our Goal is to add a Black code formattingr in Autotype.

Description

Describe the solution you'd like - Add a GitHub action that checks a PR for coding style using black. The GHA should be able to format the code and commit it to the PR if the PR is not following the coding style.

Expected outcomes

A uniform coding style across Autotype, that Autoformat code on every PR.

Skills

GitHub Actions, Python

Possible mentors

Kanishk Pachauri, Anjuman Hassan

Expected project size

50 hours.

Difficulty

Hard.

Gui For Autotype

The Command Line Interface of Autotype is great but we should enhance it with the support of GUI app. We can Create this App with the Help of Tkinter.

Update Documentation

https://github.com/tushar5526/Autotype#run-it-as-follows-if-you-are-not-familiar-with-cli-apps

This is outdated. Update accordingly.

Add a simple tests for MAC, Windows and Linux

Write a test for the simulate_keyboard.py script.

Add Templates of the Algorithms and Code to Autotype

before creating the pull request to make sure you follow all the standards. -->

Description

In Many coding contests people don't want to copy-paste their code, Sometimes they want just to write some template and with that template they write there own code.

Changes

List the changes done to fix a bug or introducing a new feature.

How to test

Describe the steps required to test the changes proposed in the pull request.

Please consider using the closing keyword if the pull request is proposed to
fix an issue already created in the repository

Embed a video or GIF in Readme demonstrating the new UI and CLI version on Autotype

Currently we have a GIF only for CLI version, which is outdated.

Code Refactoring and Publish to pypi

before creating the pull request to make sure you follow all the standards. -->

Description

Refactor Code to Better Standards and Publish the Autotype to Pypi.

Changes

• Code Refactoring
• Use of setup.py for installing and setup of CLI script
• Add missing docstrings
• Add a continuous integration service (e.g. Travis)

Intellisense on some websites automatically adds closing brackets whenever you add a opening bracket.

Remove the additional brackets added by intellisense, before autotyping again
Fix this behaviour, as it is leading to multiple extra closing brackets at the end of the autotyped code.

Roadmap for the V1 of Autotype.

1. Better File Format #39
2. Migration from requirements.txt -> pipenv
3. Publish to pip
4. New GUI version (New UI) Fixed on #34
5. executable GUI file Windows, Macos and Linux
6. Dockerising Autotype
7. Sphinx Docs

Reduce the project Size.

Currenty due to all that demo media the size of the project is around 70 mb we need to get in down.

Improvement in the GUI of Autotype.

Improvement in the GUI of Autotype.

Overview

Improvement in the GUI of Autotype for Better User Experience.

Description

The default GUI of GUI_script.py is very Minimal the Approach is to Improve the UI of Autotype to Modern UI standards.

Expected outcomes

Improved GUI of Autotype

Skills

Python, Tkinter, Some Knowledge of Design.

Possible mentors

Kanishk Pachauri, Anjuman Hassan

Expected project size

20 hours.

Difficulty

Medium

Use pre-commit instead of using the black-action-runner.

Publish Autotype to PIP

Publish Autotype to PIP

Overview

Make Autotype to Install Trough pip

Description

Package Installer for Python is the de facto and recommended package-management system written in Python and is used to install and manage software packages. It connects to an online repository of public packages, called the Python Package Index. Our Goal is the publish Autotype to pip so that users can install Autotype Via pip3 install Autotype and use is as a command line executable file ex - Autotype --help.

Expected outcomes

pip package for Autotype.

Skills

Python, pip, Unix Executable File.

Possible mentors

Kanishk Pachauri, Anjuman Hassan

Expected project size

100 hours.

Difficulty

Hard

Dockerize Autotype

Dockerizing Autotype

Overview

Make a Docker Container of Autotype for Easy Workflow.

Description

Docker is a set of platform-as-a-service products that use OS-level virtualization to deliver software in packages called containers.
Containers are isolated from one another and bundle their own software, libraries, and configuration files; they can communicate with each other through well-defined channels. The main goal is to dockerize Autotype, so that it can run on any platform without any conflict.

Expected outcomes

Working Docker Container of Autotype with proper documentation in Docs to Run it in the README.md.

Skills

Python, Docker

Possible mentors

Kanishk Pachauri, Anjuman Hassan

Expected project size

5 hours.

Difficulty

Easy

Add Support for Poetry.

before creating the pull request to make sure you follow all the standards. -->

Description

When your Python project relies on external packages, you need to make sure you’re using the right version of each package. After an update, a package might not work as it did before the update. A dependency manager like Python Poetry helps you specify, install, and resolve external packages in your projects. This way, you can be sure that you always work with the right dependency version on every machine

Changes

• Addition of Poetry and Update README.md

How to test

Describe the steps required to test the changes proposed in the pull request.

Please consider using the closing keyword if the pull request is proposed to
fix an issue already created in the repository

GUI app crashing: AttributeError [in newer versions of customtkinter]

Description:
In the GUI app, when pressing Start Typing it throws an AttributeError

How to reproduce:
Just clone the Repository and open in your IDE, run the GUI using python3 GUI_script.py
Type anything in the code/text box, press Start Typing.

Screenshots:

My Operating System : Manjaro (Arch Linux)

Logs:
Exception in Tkinter callback
Traceback (most recent call last):
File "/usr/lib/python3.10/tkinter/init.py", line 1921, in call
return self.func(*args)
File "/home/sam/.local/lib/python3.10/site-packages/customtkinter/windows/widgets/ctk_button.py", line 549, in _clicked
self._command()
File "/home/sam/Autotype/GUI_script.py", line 94, in start_typing
code = self.code.textbox.get("1.0", tk.END)
AttributeError: 'CTkTextbox' object has no attribute 'textbox'

Writing Unit Test For Autotype

Writing Unit Test For Autotype

Overview

Autotype is Widely Used For Typing Automation, It will be nice to Write Unit Test.

Description

Unit testing is a software development process in which the smallest testable parts of an application, called units, are individually and independently scrutinized for proper operation. Using Pytest write some basic Unit Test to test the Simulation of the Files. Use Tox for the Automation of These Tests.

Expected outcomes

Working Unit Test For Autotype.

Skills

Python, Unit Testing.

Possible mentors

Kanishk Pachauri, Anjuman Hassan

Expected project size

100 hours.

Difficulty

Hard

Migrate to Pyautogui from Pynput

Migrate to Pyautogui from Pynput

Description

Pynput itself contains many other problems and packages to be configured, it is better to use Pyautogui rather than pynput

Changes

• Change dependency to pyautogui from pynput

The current Ui of the script can be improved

Description

The current Ui of the script is a bit outdated and can be replaced with a better looking UI.Instead of tinkter , customtkinter library can be used in the GUI_script.py for creating a smooth and modern UI

Changes

• Re-wrote the whole GUI_script.py.
• Moved the code = """ class Complex: def __init__(self, x, y): self.x = x self.y = y """ block inside the else block.This will make the code a bit more cleaner and readable.
• Added a new attribute named Code in the Type function.

How to test

The new UI can be tested by just running the GUI_script.py in a virtual environment having all the requirements installed.

Screenshots

Dark Mode

Light Mode

Add a workflow that runs the test on every pull and push events.

#3 needs to be done before this.
You can also add a linter like prettier, black, yapf, pep8 etc. to maintain the standards.

Adding virtualenv setup steps to the Readme

Description

Many new contributors are facing issues wth pipenv. It would be better to provide them alternate setiup instructions with classic virtualenv.

Changes

• Add setup instructions to the readme with virtualenv

Fix indentation issue

Many websites have simple IntelliSense that automatically indents your cursor when you press Enter key.
This is adding extra tabs in the code that is being auto-typed.
As python depends on tabs/spaces to define blocks, we have to manually adjust the indent in python code after auto-typing.

Find a work-around for it.

Add a branch to an older version of Autotype and mention it in the docs

A lot of great features are being added in the Autotype, but I am seeing a need for users simply wanting the old script. I think we can checkout a branch to an old commit and mention the branch in the docs.

@Mr-Sunglasses you would have to do this when you have the time for it.