hippothebrave / prettycopy

A library for clean, format-friendly copy-pasting.

Hi there 👋

Hey everyone! I'm hippothebrave (she/her), but just call me Hippo. I'm a senior at Barnard College studying computer science and history. I'm new to GitHub, but excited to get started!

Languages known: Python, Java, C, SQL, Javascript, HTML/CSS

prettycopy's Issues

Add integration with AutoHotKey

It looks like AutoHotKey is a Windows scripting language for remapping keys and buttons. (https://www.autohotkey.com/)

AutoHotKey DLL apparently extends that functionality to other languages, including Python. (https://github.com/HotKeyIt/ahkdll)

More appealingly, there's AHK, a Python wrapper class (https://github.com/spyoungtech/ahk ). For hot keys, it references the original documentation here (https://www.autohotkey.com/docs/v1/Hotkeys.htm).

This would be fantastic to use with this library -- perhaps you could run a function (or press a button on the UI) that would temporarily remap Ctrl+V to one of the PrettyCopy functions, and then revert the mapping as soon as you're done using it?

And maybe (long-term) there'd be a way to integrate PrettyCopy directly into Microsoft Word!

May require quite a bit of research.

Set up project board

Fix gifs in documentation

Right now the gifs are not visible: they're just typed-out html, they don't actually resolve into images.

Some good references I found for adding gifs in markdown:
https://stackoverflow.com/questions/34341808/is-there-a-way-to-add-a-gif-to-a-markdown-file
https://gist.github.com/uupaa/f77d2bcf4dc7a294d109

Optimize code to make the library run faster

The program is weirdly slow considering how simple most of it is--I have to wait a few seconds for it to run. The code is definitely not optimized and I'm sure it could be made a lot faster.

Add integration with Google Docs

Add integration with google docs - possibly using the Apps Script API - so that you can choose your mode of copy-pasting straight from the banner.

UI for functions

Create better UI for copy-pasting functions -- they are "hidden" inside mytest.py, accessible only through command-line.

Smart copying

Would it be possible to add a function that can recognize whether it needs to add extra spaces or not, and distinguish between extraneous line breaks and actual end-of-sentences?

Setup Testing

Command Line Interface

Add a way to use PrettyCopy straight from the command line

https://python-packaging.readthedocs.io/en/latest/command-line-scripts.html

Make it pretty with an extension like Typer

https://typer.tiangolo.com/

do first deploy

Errors in the documentation

Lots of typos in the documentation. ("copy and pase") as well as logical errors (tells users to place command-line input "to the left of the flag" instead of to the right, constantly using the outdated prettycopy.prettycopy import instead of the current prettycopy import.)

Get rid of double-spacing

Is your feature request related to a problem? Please describe.
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

Describe the solution you'd like
A clear and concise description of what you want to happen.

Add a function that gets rid of unnecessary spacing!

Describe alternatives you've considered
A clear and concise description of any alternative solutions or features you've considered.

Additional context
Add any other context or screenshots about the feature request here.

Make default of quote() "[text]", not "[text],"

As stated.

Test + document copier and _cleanlines functions

Add testing and documentation for two new functions, copier and _cleanlines

Set up second issue template

Add argument checking for safety

Title says it all. Currently, I'm not checking what is on the clipboard, and that's an obvious potential problem--what if someone tries to prettycopy an image file?

Rerunning quote functions leads to nested quotation marks

I run quote() or simplequote():
"text"
I run it again:
""text""
Should only add the quotation marks once.

_cleanlines anti-pattern

_cleanlines is pass-by-value: it changes the input instead of giving an output. That's probably not right.

Low priority.

CLI should have an option for not printing the output

Note to self.

Fix code scanning alert - Clear-text storage of sensitive information

Tracking issue for:

• https://github.com/hippothebrave/prettycopy/security/code-scanning/2

do first release

add CI

UI

Add a function giving the library a basic TKinter UI, then turn it into an .exe.

Reference links:
https://stackoverflow.com/questions/5458048/how-can-i-make-a-python-script-standalone-executable-to-run-without-any-dependen
https://towardsdatascience.com/how-to-easily-convert-a-python-script-to-an-executable-file-exe-4966e253c7e9
TKinter documentation -- there's a good start on Basic-Python-Programs, might just want to add to that

deploy docs with GH pages