cosme12 / cheatsheet-maker Goto Github PK

View Code? Open in Web Editor NEW

115.0 9.0 26.0 218 KB

Cheetsheet (cheat sheet or quick reference) generator. Use it for guides, instructions or study. Made in Python 3

License: MIT License

Python 79.51% HTML 20.49%

study cheatsheet template-engine quick-reference manual guia-rapida html-generation

cheatsheet-maker's People

Contributors

Stargazers

Watchers

cheatsheet-maker's Issues

New graphic interface

Quote from reddit user u/animalAbit

Cool Project. However, the CLI interface not my favorite for this case. I would love something like editing a text file in some markdown like format and the tool would produce a neatly formatted html cheat sheet(or any desirable format) just like your final output. Something akin to jekyll, but for cheat sheets. That way, I can edit freely and also choose to reuse my work if I choose to.

Improve code organization

Quote from reddit user MrBernoulli

It looks fine, honestly. My only suggestions are to:

Put your HTML/CSS in a text file and read it in. Don't put massive text blocks in your python code.

Your comments are weird, they should be like: """ The html sheet to be created and customized. """

Did you copy and paste this a lot: ################################################
If you find yourself copy/pasting the same thing over and over, store it as a variable. That way if you wanted to use 50 #s instead of 55, you only have to change it in one place.

Translation system

Needs to be finished.
Another language should be added.

How exactly does it work?

When I run sheetmaker.py, my mouse cursor becomes a cross-hair and that is it, nothing else happens. It would be nice to have some kind of documentation on how this program is supposed to work.

404 in example from readme

Going here gives you a 404 error. The readme should probably be updated.

Export to PDF

One of the main features. It will probably be one of the most useful additions to be included. Exporting to PDF allows you to share it with people, print or open anywhere.

Help & Tips option

Help option should be added. FAQ should be listed there including tips to bypass features not fnished yet.

Crash when color style input is invalid

Hej there,
I was fiddling around a bit and put a random text when asked for the color style. Eventually, cheatsheet-maker throws an error. See my input history below:

Choose your language:
1. English
2. Español (NOT CODED YET)
1
##################################################################
#                                                                #
#                                                                #
#                 Welcome to CheatSheet Maker 1.0                #
#                                                                #
#                                                                #
##################################################################
Type the number to choose your option.
1. Create sheet
2. Export (NOT CODED YET)
3. Help (NOT CODED YET)
4. Exit
1
##################################################################
Building the basic layout... answer the next questions.
1. What is your sheet title? ('CheatSheet' is added automatically)
foo
How many columns your sheet will have?
1. 1 main column
2. 2 main columns
3. 3 main columns
1
Which color style do you prefer?
1. Orange
2. Black and white
fdsaölkj
Invalid input. Try again.
##################################################################
Building the basic layout... answer the next questions.
1. What is your sheet title? ('CheatSheet' is added automatically)
foo
How many columns your sheet will have?
1. 1 main column
2. 2 main columns
3. 3 main columns
1
Which color style do you prefer?
1. Orange
2. Black and white
1
##################################################################
Building the header... answer the next questions.
1. What is the author name?
pylipp
##################################################################
Building the footer... answer the next questions.
1. What is the author picture url?

1. What is the author website url? (use http://)
http://github.com/pylipp
1. What is the sponsor name?
Beer
1. What is the sponsor webite url? (use http://)

##################################################################
Building the blocks... answer the next questions.
0. Done
1. Create text block
2. Create block with rows
0
##################################################################
Thanks for using CheatSheet Maker. Feel free to share your ideas at http://github.com/cosme12/cheasheet-maker
Press any key to exit
Traceback (most recent call last):
  File "sheetmaker/sheetmaker.py", line 27, in <module>
    sys.exit(main())
  File "sheetmaker/sheetmaker.py", line 23, in main
    new_wizard.main_menu()
  File "/home/<user>/code/python/cheatsheet-maker/sheetmaker/sheet_wizard.py", line 91, in main_menu
    self.config_sheet()
  File "/home/<user>/code/python/cheatsheet-maker/sheetmaker/sheet_wizard.py", line 137, in config_sheet
    self.NewSheet.set_style(color)
  File "/home/<user>/code/python/cheatsheet-maker/sheetmaker/html_builder.py", line 172, in set_style
    }}""".format(color_main[self.color], color_secundary[self.color])        
KeyError: 'fdsaölkj'

Export to PNG and JPG

I think this will be harder to do than exporting to PDF. A quick google search didn't show any possible module to accomplish this.

Add more examples

There is only 1 example. A few more would be great. Screnshoots may also work. Could probably do a google search and try to "replicate" some cheat sheets

Right now, the only way to preview the sheet while you are building it is by opening the html file and reloading.
A window displaying the actual sheet, after a "new block" is added, would be a great feature.

Fails on a mac machine

Traceback (most recent call last):
  File "sheetmaker/sheetmaker.py", line 14, in <module>
    import sheet_wizard
  File "/Users/gsuga/Play/cheatsheet-maker/sheetmaker/sheet_wizard.py", line 68
SyntaxError: Non-ASCII character '\xc3' in file /Users/gsuga/Play/cheatsheet-maker/sheetmaker/sheet_wizard.py on line 68, but no encoding declared; see http://python.org/dev/peps/pep-0263/ for details

This happens in MAC machine.

cosme12 / cheatsheet-maker Goto Github PK

cheatsheet-maker's People

Contributors

Stargazers

Watchers

Forkers

cheatsheet-maker's Issues

Recommend Projects

Recommend Topics

Recommend Org