jaehoonhwang/captslog

Journal application using python

captslog's Issues

Check 01: Create Powerpoint slide

@JeewakaSankalpa @cswezey @chet0322
You guys need to create slides for your own slides.
https://docs.google.com/presentation/d/1rw1jAYDVXd3sz8eMwKy9ZHmQL5Xrk5iqsiYA5cQg7xM/edit?usp=sharing

Announcements

@chet0322 @JeewakaSankalpa @cswezey
Your pull request is due at Wednesday Mar 22 by 10 PM

[Test] Improve database test coverage

Problem description

Right now overall coverage sits at 83%.
Let's get it up to 87%.

@JeewakaSankalpa should do it, but if you think you can do it, you are more than welcome to submit a PR.

[GUI] Live editing and display text

Problem description

We have three parts in main window: list of journal entries, editor, and display

See if you can make it where when someone types in editor it pops something on display, it can be same typing sentence or something else.

But we need the triggers.

Please create appropriate pull request

Feature 04: Electron and Markdown

Once, #2 and #3 has been closed.

Conor and Chet need to work together and implement real-time markdown viewer on Electron.

Feature 06: Creating a tox environment

Self explanatory.
Use tox.

[GUI] Continued Development of GUI

If you guys need to do some work, please continue with PR.

@cswezey @chet0322

[GUI] Menu Bar/Tool bar

Menu bar implementation need by @JeewakaSankalpa

• New entry
• Save

[GUI] GUI module to classes

Problem description

Changing every widget in mainwindow.py a independent class for the sake of simpler GUI modification and addition.

[MISC]DBStatus : Save the Markdown File or Just the text inside Markdown File

Save the Markdown File

• Found a way to save the markdown file without duplication the file.
• If the Markdown Module can create a method for getMarkdownFile() which returns a File object I can work with this method.

I think this is the Best option.

Save only the text inside Markdown File

• Or else i can save just the markdown script inside the database.
• This would be easy to accomplish but also not a good way to do it in my opinion.

I Recommend we go with the First option. I believe the required method can easily be integrated into the markdown module with the help of @cswezey .

I Will work on a working sample code for this feature and have it ready probably by this Sunday after I finish working with #16

Feature 05: Create GUI Skeleton

Create GUI Skeleton for the project:

• Home Screen
• Task Views

Feature 03: Python Markdown Library

Using python markdown library, generate html.

Announcement

@JeewakaSankalpa @cswezey @chet0322
Do the slides please.

Feature 02: Get Electron working with Python Scripts

Using Flask make sure, we can send html to Electron.

[Doc] GUI Documentation

We need documentation for our GUI module.
Follow sphinx-napoleon plugin.

For reference, Check this out

[Doc] DBhandler.py Fix

In dbHandler.py documentation, we want to put argument data type.
Some of the documentation lack this argument data type.

For example:

def square(arg1, arg2, arg3):
    """title_of_function

    Summary of the function

    Args:
        arg1(int): argument1 var
        arg2(string): Something relevant
        arg3(float): Decimal points something something

    Returns:
        something_variable(object): Something Something Relevant
    """
    # Do Something
    return something_variable

[GUI] Journal Title Dialog Box

As we said in class.

@cswezey is assigned.

UI file Rearrange.

• rearrange mainwindow.py.
• separate list widget from mainwindow.py.
• rearrange path-calling in main.py.

Attention Developers

Announcement

When you are creating test, please name file as test_*.py and/or function as def test_hello

@JeewakaSankalpa @cswezey @chet0322

PyQt Editor

Progress:

The basic PyQt editor is complete. It includes a basic built-in GUI with a simple text editor layout and buttons handling basic text formatting functions.

Goals:

1. Include more PyMarkdown formatting functions and tie them into buttons/keys on the text editor toolbar.

2. Display a live update of the generated HTML from the markdown file.

3. Find a way to test the GUI so that it passes automated tests.

[GUI] Display HTML to one of GUI widget

Problem description

We need to find out a way to display html code that was output by markdown module.

In more detail, have a sample markdown file, then use python and complimentary module to translate markdown file to HTML code and then display it in one of PyQt widget.

From #24

Progress:
The basic PyQt editor is complete. It includes a basic built-in GUI with a simple text editor layout and buttons handling basic text formatting functions.
Goals:
Include more PyMarkdown formatting functions and tie them into buttons/keys on the text editor toolbar.
Display a live update of the generated HTML from the markdown file.
Find a way to test the GUI so that it passes automated tests.

[GUI][DB] From Database entry to GUI

Problem Description

So, now we have all the tools we need (independent components) we can starting building the applications.

Either @cswezey and @chet0322 should work with @JeewakaSankalpa to get database entry to GUI and display them.