vyahello/todo-task-manager

☑️ A simple todo task application (flask, heroku)

Todo task master

A simple todo task application written in flask python micro-web framework.

Tools

Production

• python 3.8
• flask
• html5/css
• shell
• heroku

Development

• github actions CI
• pytest framework
• black code formatter
• mypy static tyler
• pylint code style
• flake8 code formatter

Quick start

Run script from the root directory of the project:

git clone git@github.com:vyahello/todo-task-manager.git
cd todo-task-manager
pip install -r requirements.txt
python todo.py

Development notes

Run static code analysis

In general static code analysis consists of following tools: black, flake8, pylint, mypy, pydocstyle and unittests accordingly. To be able to start static code analysis locally please run following script from the root directory of the project:

./run-code-analysis.sh install-dependencies

Anyway, this script is triggered via Travis CI and GitHub CI.

Deployment on heroku

Please check deployment file for app deployment.

Release notes

Please check changelog file to get more details about actual versions and it's release notes.

Meta

Author – Volodymyr Yahello vyahello@gmail.com

Distributed under the Apache 2.0 license. See LICENSE for more information.

You can reach out me at:

• https://twitter.com/vyahello
• https://www.linkedin.com/in/volodymyr-yahello-821746127

Contributing

I would highly appreciate any contribution and support. If you are interested to add your ideas into project please follow next simple steps:

1. Clone the repository
2. Configure git for the first time after cloning with your name and email
3. pip install -r requirements.txt to install all project dependencies
4. pip install -r requirements-dev.txt to install all development project dependencies
5. Create your feature branch (git checkout -b feature/fooBar)
6. Commit your changes (git commit -am 'Add some fooBar')
7. Push to the branch (git push origin feature/fooBar)
8. Create a new Pull Request