A TodoGARPIX App

What is this?

This is a TodoGARPIX was completed as part of the test task when applying for an internship at GARPIX.

What can?

see the list of tasks
create a new task
detailed task overview
change one task
delete task

Requirements

aniso8601==9.0.1
appdirs==1.4.4
attrs==21.2.0
black==21.6b0
certifi==2021.5.30
chardet==4.0.0
click==7.1.2
Flask==1.1.4
flask-restx==0.4.0
idna==2.10
isort==5.9.1
itsdangerous==1.1.0
Jinja2==2.11.3
jsonschema==3.2.0
MarkupSafe==2.0.1
mypy-extensions==0.4.3
pathspec==0.8.1
peewee==3.14.4
pyrsistent==0.17.3
pytz==2021.1
regex==2021.4.4
requests==2.25.1
six==1.16.0
toml==0.10.2
urllib3==1.26.5
Werkzeug==1.0.1

Getting started

clone:

$ git clone https://github.com/greyli/todoism.git
$ cd todoism

create & activate virtual env then install dependency:

with venv/virtualenv + pip:

$ python -m venv env  # use `virtualenv env` for Python2, use `python3 ...` for Python3 on Linux & macOS
$ source env/bin/activate  # use `env\Scripts\activate` on Windows
$ pip install -r requirements.txt

RESTful interactions

Use Swagger UI or cUrl utility to manipulate tasks. Below is an example of using the cUrl utility:

GET the List of todos

curl -H 'Content-Type: application/json' -X 'GET' 'http://127.0.0.1:5000/api/task/'

GET an individual todo

curl -H 'Content-Type: application/json' -X 'GET' 'http://127.0.0.1:5000/api/task/<ID>'

POST a todo

curl -H 'Content-Type: application/json' -d '{"title":"Dinner", "content":"Having Dinner"}' -X 'POST' 'http://127.0.0.1:5000/api/task/'

UPDATE a todo

curl -H 'Content-Type: application/json' -d '{"title":"Dinner", "content":"Having Dinner"}' -X 'PUT' 'http://127.0.0.1:5000/api/task/<ID>'

DELETE a todo

curl -H 'Content-Type: application/json' -X 'DELETE' 'http://127.0.0.1:5000/api/task/<ID>'

UnitTEST

To run the tests, you can use unittest as following:

$ python3 -m unittest tests/test_api.py
.......
----------------------------------------------------------------------
Ran 7 tests in 0.076s

OK

License

MIT

halexx7 / TodoGARPIX