zerasul / blask Goto Github PK

I've just installed Blask with pip and I don't know how to run it. Using the traditional method with FLASK_APP seems doesn't work.

Add Integration with Git (or other SCM), for automatic update of posts folder.

in #17 we introduce Category Metadata attribute to post's metadata, a new feature is to search against post category.

Documentation seems a bit confused. We need to write a tutorial,how install Blask and how to start using it!

Add More Metadata Attributes like author or category.

Add a README.MD file with information about the project and the integration with CI tools.

Installing pip install blask. An error was found:

"unknown module m2r"

A pip install m2r before the installation of blask fix the error.

See the setup script and install it before the installation.

A how-to-hacking guide for Blask will be very interesting. As a file or Wiki.

Add HTTPS support, of getblask.com.

Steps to reproduce: install with pip3 on Bash on Windows

Based on Ubuntu 16.04

Installed /tmp/pip-install-f43rlj95/markdown-full-yaml-metadata/setuptools_markdown-0.2-py3.4.egg
    Searching for pypandoc
    Reading https://pypi.python.org/simple/pypandoc/
    Best match: pypandoc 1.4
    Downloading https://files.pythonhosted.org/packages/71/81/00184643e5a10a456b4118fc12c96780823adb8ed974eb2289f29703b29b/pypandoc-1.4.tar.gz#sha256=e914e6d5f84a76764887e4d909b09d63308725f0cbb5293872c2c92f07c11a5b
    Processing pypandoc-1.4.tar.gz
    Writing /tmp/easy_install-a26dj6bs/pypandoc-1.4/setup.cfg
    Running pypandoc-1.4/setup.py -q bdist_egg --dist-dir /tmp/easy_install-a26dj6bs/pypandoc-1.4/egg-dist-tmp-vy80fo9l
    Maybe try:

        sudo apt-get install pandoc
    See http://johnmacfarlane.net/pandoc/installing.html
    for installation options
    ---------------------------------------------------------------

    zip_safe flag not set; analyzing archive contents...
    pypandoc.__pycache__.__init__.cpython-34: module references __file__


    !!! pandoc not found, long_description is bad, don't upload this to PyPI !!!



    Installed /tmp/pip-install-f43rlj95/markdown-full-yaml-metadata/pypandoc-1.4-py3.4.egg
    Traceback (most recent call last):
      File "<string>", line 1, in <module>
      File "/tmp/pip-install-f43rlj95/markdown-full-yaml-metadata/setup.py", line 19, in <module>
        version='0.0.2',
      File "/usr/lib/python3.4/distutils/core.py", line 108, in setup
        _setup_distribution = dist = klass(attrs)
      File "/usr/lib/python3/dist-packages/setuptools/dist.py", line 239, in __init__
        self.fetch_build_eggs(attrs.pop('setup_requires'))
      File "/usr/lib/python3/dist-packages/setuptools/dist.py", line 264, in fetch_build_eggs
        replace_conflicting=True
      File "/usr/lib/python3/dist-packages/pkg_resources.py", line 620, in resolve
        dist = best[req.key] = env.best_match(req, ws, installer)
      File "/usr/lib/python3/dist-packages/pkg_resources.py", line 852, in best_match
        dist = working_set.find(req)
      File "/usr/lib/python3/dist-packages/pkg_resources.py", line 503, in find
        raise VersionConflict(dist,req)     # XXX add more info
    pkg_resources.VersionConflict: (wheel 0.24.0 (/usr/lib/python3/dist-packages), Requirement.parse('wheel>=0.25.0'))

Add travis task to report any security issue related with the code smells

Yesterday we detect some errors on travis; we see that the new version of pytest have some errors on the execution.

We have to fix those errors.

Integrate the project with coveralls.io for see the coverage of the project; And use the file README.md (#3) for show the badge.

Can Be a good Idea use Custom Erro Pages using Markdown. This information about the markdown files can be at config.py

Design a new Logo for the project.

tip: a Mantis....

pipenv reads the .env files automatically, loading the environment variables that we put into them.

It is a very powerful way to correctly configure an application, following the indications of "The Twelve-Factor App".

An example of a settings.py file converted to an .env file could be the following:

desarrollo@desarrollo:~/Proyectos/pipenv/blask$ cat .env

# Minimal conf for Blask
FLASK_APP=main.py

# Name of the Template Folder.
templateDir="templates"

# Name of the post Folder
postDir="posts"

# default name of the template file.
defaultLayout="template.html"

# Default name of the static Folder
staticDir="static"

# Title of the blog
tittle="Blask | A Simple Blog Engine Based on Flask"

All the environment variables that we want to define, can be included in the .env file.

.gitignore excludes the .env file so that it can not be versioned, so that we can store sensitive data inside it.

A very popular custom is to create a file .env.example, with sample data, so that other developers find it very easy to generate their own .env file from the .env.example file .

Create a tool or BackOffice for creation of a post on Markdown.

Seems very "expanded", there is a minimal margin between content borders and screen borders.

Adding class container to header and content can fix this. container-fluid class needs a container first.

Example with container class.

Add more tests. (Unit tests and Integration Tests).

Create a mailing list for contribute to the project.

As Flask you can run it using the command flask run; using Flask.cli tools we can use a new command called Blask and run blaks with:

Blask run

Update and test dependencies for use with Flask 1.0.

This can be a good feature; because the configuration can be more readable and it can be exportable.

add author search post feature using /author/ as url template.

add a date ordering on blask.

add search functionability.

Jekyll uses gems for template files. As I know, Flask can use modules for the templating system. So we can add a simply guide to the documentation.

With the last changes, the quality gate of SonarCloud fails; because the new code is not covered by tests. We need to create new tests that covers all those lines.

Lines to Cover in Sonar Cloud

Integrate the project with the CI engine Travis.

Generate the content of Contact Page.

Generate the information of Examples page.

http://getblask.com/examples

Generate the content of Documentation Page.

create a menu module for generating a menu with the blogs configures.

use a metadata called menu.

Generate the content of About Page.

That will fix the README file on PyPI

During the tests we are seeing the next warning message:

DeprecationWarning: Extension classes accepting a dict on the single keyword "config" is pending Deprecation. Each setting should be passed into the Class as a keyword directly. The "config" keyword is deprecated and raise an error in version 2.7. See the Release Notes for Python-Markdown version 2.6 for more info.
DeprecationWarning)

That's because a new change on Markdown extensions library. We have to check this and remove this message.

There is an error on code highligth that dosent show colors and don't respect endline characters.

There is a setup.py file but can be a great idea to upload the package to Pypi.

Review Security on blask and dependencies.

Adding theme support for Blask

Change the style of your blog by setting a config variable.

add support to internationalization and choose the same page using a metadata.

Add Docs String to source Code.

Integrate the project with sonarsource for improve code quality.

Thanks for linking to Mozilla's Community Participation Guidelines! Can you add contact info so people contributing to your project can reach out to someone? Thanks!

Add setup.py with information about the project.

OS: Bash on Windows (not last version)
Steps to reproduce:

• Clone the repo
• Export environment variable
• Run blaskcli run

[19:12:35] [~/blask] [master *] → blaskcli run
Traceback (most recent call last):
  File "/usr/local/bin/blaskcli", line 5, in <module>
    from pkg_resources import load_entry_point
  File "/usr/lib/python3/dist-packages/pkg_resources.py", line 2749, in <module>
    working_set = WorkingSet._build_master()
  File "/usr/lib/python3/dist-packages/pkg_resources.py", line 444, in _build_master
    ws.require(__requires__)
  File "/usr/lib/python3/dist-packages/pkg_resources.py", line 725, in require
    needed = self.resolve(parse_requirements(requirements))
  File "/usr/lib/python3/dist-packages/pkg_resources.py", line 628, in resolve
    raise DistributionNotFound(req)
pkg_resources.DistributionNotFound: markdown-full-yaml-metadata