Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/vyahello/todo-task-manager
☑️ A simple todo task application (flask, heroku)
https://github.com/vyahello/todo-task-manager
flask-application heroku rest-api
Last synced: about 1 month ago
JSON representation
☑️ A simple todo task application (flask, heroku)
- Host: GitHub
- URL: https://github.com/vyahello/todo-task-manager
- Owner: vyahello
- License: apache-2.0
- Created: 2019-06-14T14:27:18.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-04-28T09:07:24.000Z (10 months ago)
- Last Synced: 2024-11-15T17:45:56.318Z (3 months ago)
- Topics: flask-application, heroku, rest-api
- Language: Python
- Homepage: https://todo-task-master.herokuapp.com
- Size: 305 KB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
[](https://www.python.org/)
[](https://travis-ci.org/vyahello/todo-task-manager)
[](https://coveralls.io/github/vyahello/todo-task-manager?branch=master)
[](https://www.elegantobjects.org)
[](LICENSE.md)
# Todo task master
A simple todo task application written in [flask](http://flask.palletsprojects.com) python micro-web framework.
## Tools
### Production
- python 3.8
- [flask](http://flask.palletsprojects.com)
- html5/css
- shell
- [heroku](https://todo-task-master.herokuapp.com)
### Development
- [github actions](https://github.com/vyahello/todo-task-manager/actions/workflows/code-assessment.yml) CI
- [pytest](https://pypi.org/project/pytest/) framework
- [black](https://black.readthedocs.io/en/stable/) code formatter
- [mypy](http://mypy.readthedocs.io/en/latest) static tyler
- [pylint](https://www.pylint.org/) code style
- [flake8](http://flake8.pycqa.org/en/latest/) code formatter
## Quick start
Run script from the root directory of the project:
```bash
git clone [email protected]: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:
```bash
./run-code-analysis.sh install-dependencies
```
Anyway, this script is triggered via `Travis CI` and `GitHub CI`.
## Deployment on heroku
Please check [deployment](DEPLOYMENT.md) file for app deployment.
## Release notes
Please check [changelog](CHANGELOG.md) file to get more details about actual versions and it's release notes.
## Meta
Author – Volodymyr Yahello [email protected]
Distributed under the `Apache 2.0` license. See [LICENSE](LICENSE.md) for more information.
You can reach out me at:
* [https://twitter.com/vyahello](https://twitter.com/vyahello)
* [https://www.linkedin.com/in/volodymyr-yahello-821746127](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