Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/marcosvbras/todo-list-python
A simple To Do List with Python and Flask Framework
https://github.com/marcosvbras/todo-list-python
flask flask-api heroku pipenv pytest python rest-api tdd travis-ci web
Last synced: 3 months ago
JSON representation
A simple To Do List with Python and Flask Framework
- Host: GitHub
- URL: https://github.com/marcosvbras/todo-list-python
- Owner: marcosvbras
- License: apache-2.0
- Created: 2018-04-14T12:09:09.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2022-12-08T01:03:42.000Z (almost 2 years ago)
- Last Synced: 2024-05-29T23:19:33.967Z (5 months ago)
- Topics: flask, flask-api, heroku, pipenv, pytest, python, rest-api, tdd, travis-ci, web
- Language: Python
- Homepage:
- Size: 164 KB
- Stars: 13
- Watchers: 4
- Forks: 114
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-todos - Python
README
# TODO List in Python
[](https://travis-ci.org/marcosvbras/todo-list-python)
## What is this?
**TO DO List** is a simple API project created with everything that I learned on course [Do Zero ao Deploy](https://github.com/cassiobotaro/do_zero_ao_deploy) by [Cássio Botaro](https://github.com/cassiobotaro/).
This project covers the following concepts:
- Python environments with [Pipenv](https://github.com/pypa/pipenv)
- Test Driven Development with [PyTest](https://docs.pytest.org/en/latest/)
- Starting with [Flask](http://flask.pocoo.org/) framework
- Continuous Integration with [Travis](https://travis-ci.org/)
- Continuous Deployment with [Heroku](https://www.heroku.com/)
Starting from what has been taught, I improved the API with **MongoDB** persistence.
## Environment
### API
All code was written with **Python 3.6**, so, for a correct running, it is recommended to install this one.
After Python installed, it is required to install all dependencies. You can use [Pipenv](https://github.com/pypa/pipenv) or [Virtualenv](https://virtualenv.pypa.io/en/stable/). If you are using **Pipenv**, use the following command to install from **Pipfile**:
```bash
$ pipenv install
```
...and active the environment:
```bash
$ pipenv shell
```
However, if you are using **Virtualenv**, you need to activate the environment and install from **requirements.pip** file:
```bash
$ source YOUR_ENVIRONMENT_DIRECTORY/bin/activate
$ pip install -r requirements.pip
```
### Database
Install [MongoDB](https://www.mongodb.com/) in your machine and be sure **MongoDB** process is running.
## How to run
```bash
$ python todo.py
* Running on http://127.0.0.1:5000/ (Press CTRL+C to quit)
```
API Endpoints:
- `GET /tasks`: Return all tasks available
- `POST /tasks`: Create a new task
## Testing (Optional)
You can test the application using the development dependencies.
Install all development dependencies from **Pipfile**:
```bash
$ pipenv install --dev
```
Or from **dev-requirements.pip** file if you are using **VirtualEnv**:
```bash
$ pip install -r dev-requirements.pip
```
To debug endpoints, you can use [HTTPie](https://httpie.org/) as following:
```bash
$ http http://127.0.0.1:5000/tasks
[
{
"_id": {
"$oid": "5ad3d924e3bdea6ccf9d9d3e"
},
"description": "The Best Description",
"done": false,
"title": "The Best Title"
},
{
"_id": {
"$oid": "5ad3d8fae3bdea6c41d571f4"
},
"description": "The Incredible Description",
"done": false,
"title": "The Incredible Title"
}
]
```
```bash
$ http POST http://127.0.0.1:5000/tasks title=Test description=Test
HTTP/1.0 201 CREATED
Content-Length: 123
Content-Type: application/json
Date: Mon, 16 Apr 2018 00:23:45 GMT
Server: Werkzeug/0.14.1 Python/3.6.2
{
"_id": {
"$oid": "5ad3ed11e3bdea06aa7afa06"
},
"description": "Test",
"done": false,
"title": "Test"
}
```
To run the tests, you can use [PyTest](https://docs.pytest.org/en/latest/) as following:
```bash
$ python -m pytest
...
collected 7 items
test_todo.py ....... [100%]
========================== 7 passed in 1.32 seconds ==========================
```