Taskcamp
This software is used for educational and demonstrative purposes. It's a simple project management tool powered by Django Framework
Features:
- Class-Based Views approach
- Login, Sign Up, Recover (LoginView, FormView, UserCreationForm, PasswordResetForm, LogoutView, PasswordResetView, PasswordResetDoneView, PasswordResetConfirmView, PasswordResetCompleteView)
- Custom Extended User model (AbstractUser, BaseUserManager, UserManager)
- Permissions and Groups (LoginRequiredMixin, PermissionRequiredMixin)
- Simple CRUD views (ListView, DetailView, CreateView, UpdateView, DeleteView)
- File uploading
- Statistics (TemplateView, View, Q, F, Count, FloatField, Cast, Case, When, Sum, Avg)
- Forms (Form, ModelForm)
- Admin page (ModelAdmin, TabularInline)
- Template and layouts (include templates, blocks, custom 500, 404, 403 handlers)
- Router urls (include, namespace, params)
- Caching (memcached)
- Async workers with celery
- Localization and internationalization (with pluralization)
- Timezone support (pytz)
- Markdown syntax, Status highlight (Template tags)
- DB router (master, slave)
- Unittests with coverage
- Uwsgi (with static and media serving)
- Docker and docker-compose
- kubernetes deploy
Components:
- Database PostgreSQL
- Cache memcached
- Application server uWSGI
- Task queue Celery
- Message Broker RabbitMQ
- Localization gettext
- Markup language Markdown
- Template Engine Jinja2
- Debugging, profiling and optimizing Django Debug Toolbar
Install
Types of installation
Bare metal install
- install python3 and create virtual env
python3 -m venv venv
source venv/bin/activate
- install requirements
pip install -r requirements.txt
- put django secret key into file .env generate DJANGO_SECRET_KEY
echo DJANGO_SECRET_KEY=\'$(python3 -c 'from django.core.management.utils import get_random_secret_key; print(get_random_secret_key())')\' >> .env
or just create test
echo DJANGO_SECRET_KEY=test_secret_key >> .env
- add connection data to
.envfile
>.env << __EOF__
RABBITMQ_HOST=192.168.10.1
RABBITMQ_PORT=5673
RABBITMQ_DEFAULT_USER=admin
RABBITMQ_DEFAULT_PASS=adminsecret
RABBITMQ_DEFAULT_VHOST=celery
POSTGRES_HOST=192.168.10.1
POSTGRES_PORT=5434
POSTGRES_DB=taskcamp
POSTGRES_USER=taskcamp
POSTGRES_PASSWORD=secret
MEMCACHED_LOCATION=192.168.10.1:11214
EMAIL_HOST=192.168.10.1
EMAIL_PORT=1025
__EOF__
# if you need a debug be enabled
>>.env << __EOF__
DJANGO_DEBUG=True
__EOF__
#if you need to keep celery results
>>.env << __EOF__
REDIS_RESULTS_BACKEND=redis://192.168.10.1:6380/0
__EOF__
- create and run postgresql, memcached, mailcatcher and rabbitmq instance (if needed)
docker run -d --name taskcamp-postgres --hostname taskcamp-postgres \
-p 5434:5432 --env-file .env postgres:13-alpine
docker run -d -p 11214:11211 --name taskcamp-memcached memcached:alpine
docker run -d -p 15673:15672 -p 5673:5672 \
--name taskcamp-rabbit --hostname taskcamp-rabbit \
--env-file .env rabbitmq:3.8.14-management-alpine
docker run -d -p 1080:1080 -p 1025:1025 \
--name taskcamp-mailcatcher iliadmitriev/mailcatcher
# if you enabled REDIS_RESULTS_BACKEND to store celery results
docker run -d --name taskcamp-redis --hostname taskcamp-redis \
-p 6380:6379 redis:alpine
- export variables from .env file
export $(cat .env | xargs)
- create a db (run migrations)
python3 manage.py migrate --no-input
- compile messages
python3 manage.py compilemessages -i venv
- create superuser
python3 manage.py createsuperuser
Docker install
Prepare
- create
.envfile
>.env << __EOF__
RABBITMQ_HOST=taskcamp-rabbitmq
RABBITMQ_PORT=5672
RABBITMQ_DEFAULT_USER=admin
RABBITMQ_DEFAULT_PASS=adminsecret
RABBITMQ_DEFAULT_VHOST=celery
POSTGRES_HOST=taskcamp-postgres
POSTGRES_PORT=5432
POSTGRES_DB=taskcamp
POSTGRES_USER=taskcamp
POSTGRES_PASSWORD=secret
MEMCACHED_LOCATION=taskcamp-memcached:11211
REDIS_RESULTS_BACKEND=redis://taskcamp-redis:6379/0
EMAIL_HOST=taskcamp-mail
EMAIL_PORT=1025
__EOF__
- create network
taskcamp-network
docker network create taskcamp-network
- create docker containers (this is just an example, you shouldn't run in production like this)
docker run -d --name taskcamp-postgres --hostname taskcamp-postgres \
--env-file .env --network taskcamp-network postgres:13-alpine
docker run -d --name taskcamp-memcached --hostname taskcamp-memcached \
--network taskcamp-network memcached:alpine
docker run -d \
--name taskcamp-rabbitmq --hostname taskcamp-rabbitmq \
--env-file .env --network taskcamp-network \
rabbitmq:3.8.14-management-alpine
docker run -d --name taskcamp-mail --hostname taskcamp-mail \
--network taskcamp-network -p 1080:1080 iliadmitriev/mailcatcher
docker run -d --name taskcamp-redis --hostname taskcamp-redis \
--network taskcamp-network redis:alpine
Build and run
- build docker image
taskcamp-python
docker build -t taskcamp-python -f Dockerfile ./
- run django web application
docker run -p 8000:8000 --env-file=.env -d --name=taskcamp-django \
--hostname=taskcamp-django --network taskcamp-network taskcamp-python
- run celery
docker run --env-file=.env -d --name=taskcamp-celery --hostname=taskcamp-celery \
--network taskcamp-network taskcamp-python python3 -m celery -A worker worker
- apply migrations
docker run --env-file=.env --rm -ti --network taskcamp-network taskcamp-python \
python3 manage.py migrate
- create superuser
docker run --env-file=.env --rm -ti --network taskcamp-network taskcamp-python \
python3 manage.py createsuperuser
Clean up
docker rm -f $(docker ps --filter name=^taskcamp -a -q)
docker network rm taskcamp-network
docker rmi taskcamp-python
Docker-compose install
- create
.envenvironment variables file
>.env << __EOF__
RABBITMQ_HOST=taskcamp-rabbitmq
RABBITMQ_PORT=5672
RABBITMQ_DEFAULT_USER=admin
RABBITMQ_DEFAULT_PASS=adminsecret
RABBITMQ_DEFAULT_VHOST=celery
POSTGRES_HOST=taskcamp-postgres
POSTGRES_PORT=5432
POSTGRES_DB=taskcamp
POSTGRES_USER=taskcamp
POSTGRES_PASSWORD=secret
MEMCACHED_LOCATION=taskcamp-memcached:11211
REDIS_RESULTS_BACKEND=redis://taskcamp-redis:6379/0
EMAIL_HOST=taskcamp-mail
EMAIL_PORT=1025
__EOF__
- start docker-compose services
docker-compose up -d
- apply migrations
docker-compose exec django python3 manage.py migrate
- create superuser
docker-compose exec django python3 manage.py createsuperuser
- load test data if needed
cat data.json | docker-compose exec -T django python3 manage.py loaddata --format=json -
Docker-compose clean up
docker-compose down --rmi all --volumes
Development
- set environment variables
DJANGO_DEBUG=True
- make migrations and migrate
python3 manage.py makemigrations
python3 manage.py migrate
- make messages
python3 manage.py makemessages -a -i venv
python3 manage.py compilemessages -i venv
- run
python3 manage.py runserver 0:8000
- run celery for emails and other async tasks
python3 -m celery -A worker worker
# or
celery -A worker worker
- run celery for emails and other async tasks
python3 -m celery -A worker worker
# or
celery -A worker worker
with log level and queue
celery -A worker worker -l INFO -Q email
Testing
Run tests
- run all tests
python3 manage.py test
- run with keeping db in case of test fails
python3 manage.py test --keepdb
- run all tests with details
python3 manage.py test --verbosity=2
Run tests with coverage
- run with coverage
coverage run manage.py test --verbosity=2
- print report with missing lines and fail with error in case it's not fully covered
coverage report -m --fail-under=100
16 Oct 20, 2022
26 Sep 10, 2022
1 Feb 07, 2022
6 Dec 31, 2021
4 Nov 16, 2021
4 Sep 26, 2022
1 Nov 07, 2021
1 Sep 09, 2022
383 Jan 06, 2023
2.1k Jan 04, 2023
42 Dec 16, 2022
1 Dec 06, 2021
2 Oct 20, 2021
19 Oct 22, 2022
2 Feb 04, 2022
1.1k Dec 26, 2022
1 Dec 08, 2021
2.2k Jan 02, 2023
6 Aug 02, 2022