A simple and flexible task management web application
About • Installation • Usage • Demo • Additionally
Table of Contents
A task management web application built with Python and Django framework. It allows you to set tasks, assign performers and change their statuses. Registration and authentication are required to work with the system.
To provide users with a convenient, adaptive, modern interface, the project uses the Bootstrap framework.
The frontend is rendered on the backend. This means that the page is built by the DjangoTemplates backend, which returns prepared HTML. And this HTML is rendered by the server.
PostgreSQL is used as the object-relational database system.
--> Demo <--
- Set tasks;
- Assign performers;
- Change task statuses;
- Set multiple tasks labels;
- Filter the tasks displayed;
- User authentication and registration;
For user authentication, the standard Django tools are used. In this project, users will be authorized for all actions, that is, everything is available to everyone.
Each task in the task manager usually has a status. With its help you can understand what is happening to the task, whether it is done or not. Tasks can be, for example, in the following statuses: new, in progress, in testing, completed.
Tasks are the main entity in any task manager. A task consists of a name and a description. Each task can have a person to whom it is assigned. It is assumed that this person performs the task. Also, each task has mandatory fields - author (set automatically when creating the task) and status.
Labels are a flexible alternative to categories. They allow you to group the tasks by different characteristics, such as bugs, features, and so on. Labels are related to the task of relating many to many.
When the tasks become numerous, it becomes difficult to navigate through them. For this purpose, a filtering mechanism has been implemented, which has the ability to filter tasks by status, performer, label presence, and has the ability to display tasks whose author is the current user.
Why not just let Docker Compose do all the work, right? Of course, for the magic to happen, Docker must be installed and running.
Clone the project:
>> git clone https://github.com/ivnvxd/python-project-52.git && cd python-project-52Create .env file in the root folder and add following variables:
DATABASE_URL=postgresql://postgres:password@db:5432/postgres
SECRET_KEY={your secret key} # Django will refuse to start if SECRET_KEY is not set
LANGUAGE=en-us # By default the app will use ru-ru localeAnd run:
>> docker-compose upVoila! The server is running at http://0.0.0.0:8000 and you can skip directly to Available Actions section.
There is always an option for those who like to do everything by themselves.
Before installing the package make sure you have Python version 3.8 or higher installed:
>> python --version
Python 3.8+The project uses the Poetry dependency manager. To install Poetry use its official instruction.
There are two main options for using a database management system for this project: PostgreSQL and SQLite.
PostgreSQL is used as the main database management system. You have to install it first. It can be downloaded from official website or installed using Homebrew:
>> brew install postgresqlAlternatively you can skip this step and use SQLite database locally.
To use the application, you need to clone the repository to your computer. This is done using the git clone command. Clone the project:
>> git clone https://github.com/ivnvxd/python-project-52.git && cd python-project-52After that install all necessary dependencies:
>> make installCreate .env file in the root folder and add following variables:
DATABASE_URL=postgresql://{provider}://{user}:{password}@{host}:{port}/{db}
SECRET_KEY={your secret key} # Django will refuse to start if SECRET_KEY is not set
LANGUAGE=en-us # By default the app will use ru-ru localeIf you choose to use SQLite DBMS, do not add DATABASE_URL variable.
To create the necessary tables in the database, start the migration process:
>> make migrateStart the Gunicorn Web-server by running:
>> make startBy default, the server will be available at http://0.0.0.0:8000.
It is also possible to start it local in development mode using:
>> make devThe dev server will be at http://127.0.0.1:8000.
- Registration — First, you need to register in the application using the registration form provided;
- Authentication — To view the list of tasks and create new ones, you need to log in using the information from the registration form;
- Users — You can see the list of all registered users on the corresponding page. It is available without authorization. You can change or delete information only about yourself. If a user is the author or performer of a task, it cannot be deleted;
- Statuses — You can view, add, update, and delete task statuses if you are logged in. Statuses corresponding to any tasks cannot be deleted;
- Tasks — You can view, add, and update tasks if you are logged in. Only the task creator can delete tasks. You can also filter tasks on the corresponding page with specified statuses, performers, and labels;
- Labels — You can view, add, update, and delete task labels if you are logged in. Labels matching any tasks cannot be deleted.
The demo version is available on Railway platform: https://python-task-manager.up.railway.app/
- python = "^3.8.1"
- Django = "^4.1.5"
- python-dotenv = "^0.21.0"
- dj-database-url = "^0.5.0"
- gunicorn = "^20.1.0"
- django-bootstrap4 = "^22.3"
- whitenoise = "^6.3.0"
- django-extensions = "^3.2.1"
- django-filter = "^22.1"
- rollbar = "^0.16.3"
- psycopg2 = "^2.9.5"
- flake8 = "^6.0.0"
- coverage = "^7.0.5"
- ipython = "^8.8.0"
make install- Install all dependencies of the package.
make migrate- Generate and apply database migrations.
make dev- Run Django development server at http://127.0.0.1:8000/
make start- Start the Gunicorn web server at http://0.0.0.0:8000 if no port is specified in the environment variables.
make lint- Check code with flake8 linter.
make test- Run tests.
make check- Validate structure of
pyproject.tomlfile, check code with tests and linter. make shell- Start Django shell (iPython REPL).
Project Tree
.
├── Dockerfile
├── Makefile
├── README.md
├── coverage.xml
├── db.sqlite3
├── docker-compose.yml
├── locale
│ └── ru
│ └── LC_MESSAGES
│ ├── django.mo
│ └── django.po
├── manage.py
├── poetry.lock
├── pyproject.toml
├── requirements.txt
├── setup.cfg
├── static
└── task_manager
├── __init__.py
├── asgi.py
├── fixtures
│ ├── label.json
│ ├── status.json
│ ├── task.json
│ ├── test_label.json
│ ├── test_status.json
│ ├── test_task.json
│ ├── test_user.json
│ └── user.json
├── helpers.py
├── labels
│ ├── __init__.py
│ ├── admin.py
│ ├── apps.py
│ ├── forms.py
│ ├── migrations
│ │ ├── 0001_initial.py
│ │ └── __init__.py
│ ├── models.py
│ ├── tests
│ │ ├── __init__.py
│ │ ├── test_forms.py
│ │ ├── test_models.py
│ │ ├── test_post.py
│ │ ├── test_view.py
│ │ └── testcase.py
│ ├── urls.py
│ └── views.py
├── mixins.py
├── settings.py
├── statuses
│ ├── __init__.py
│ ├── admin.py
│ ├── apps.py
│ ├── forms.py
│ ├── migrations
│ │ ├── 0001_initial.py
│ │ └── __init__.py
│ ├── models.py
│ ├── tests
│ │ ├── __init__.py
│ │ ├── test_forms.py
│ │ ├── test_models.py
│ │ ├── test_post.py
│ │ ├── test_view.py
│ │ └── testcase.py
│ ├── urls.py
│ └── views.py
├── tasks
│ ├── __init__.py
│ ├── admin.py
│ ├── apps.py
│ ├── filters.py
│ ├── forms.py
│ ├── migrations
│ │ ├── 0001_initial.py
│ │ ├── 0002_initial.py
│ │ └── __init__.py
│ ├── models.py
│ ├── tests
│ │ ├── __init__.py
│ │ ├── test_forms.py
│ │ ├── test_models.py
│ │ ├── test_post.py
│ │ ├── test_view.py
│ │ └── testcase.py
│ ├── urls.py
│ └── views.py
├── templates
│ ├── 404.html
│ ├── base.html
│ ├── footer.html
│ ├── form.html
│ ├── index.html
│ ├── labels
│ │ ├── delete.html
│ │ └── labels.html
│ ├── navbar.html
│ ├── statuses
│ │ ├── delete.html
│ │ └── statuses.html
│ ├── tasks
│ │ ├── delete.html
│ │ ├── task_show.html
│ │ └── tasks.html
│ └── users
│ ├── delete.html
│ └── users.html
├── tests.py
├── urls.py
├── users
│ ├── __init__.py
│ ├── admin.py
│ ├── apps.py
│ ├── forms.py
│ ├── migrations
│ │ ├── 0001_initial.py
│ │ └── __init__.py
│ ├── models.py
│ ├── tests
│ │ ├── __init__.py
│ │ ├── test_forms.py
│ │ ├── test_models.py
│ │ ├── test_post.py
│ │ ├── test_view.py
│ │ └── testcase.py
│ ├── urls.py
│ └── views.py
├── views.py
└── wsgi.py
This is the fourth and final training project of the "Python Developer" course on Hexlet.io
GitHub @ivnvxd · LinkedIn @Andrey Ivanov