https://github.com/coci/duckiter
Duckiter will Automatically dockerize your Django projects.
https://github.com/coci/duckiter
cli django docker dockerfile python3
Last synced: 5 days ago
JSON representation
Duckiter will Automatically dockerize your Django projects.
- Host: GitHub
- URL: https://github.com/coci/duckiter
- Owner: coci
- License: gpl-3.0
- Created: 2021-02-14T08:02:19.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2023-12-15T14:39:36.000Z (about 2 years ago)
- Last Synced: 2025-09-30T15:02:22.220Z (4 months ago)
- Topics: cli, django, docker, dockerfile, python3
- Language: Python
- Homepage:
- Size: 69.3 KB
- Stars: 23
- Watchers: 2
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: HISTORY.md
- License: LICENSE
Awesome Lists containing this project
README
# Duckiter
Duckiter will Automatically dockerize your Django projects.
### Requirements :
- python version : python version 3.6 or upper version
- OS :
- linux
- MacOS
- windows ( drop support )
- docker engine installed in your machine and already run through the usage of package
### Installation :
clone project:
```
pip install duckiter
```
### Usage :
Duckiter has two individual steps:
1- initialize Dockerfile
2- build image from created Dockerfile
#### To initialize Dockerfile (step 1) :
in terminal hit to your project directory ( where manage.py is in root ):
```
duckiter --init
```
This will create Dockerfile and config.cfg in the root of the project, and you can manipulate those files before Duckiter creates an image.
If you are ok with our configurations, you can just pass '-b' to immediately build the image right after creating the Dockerfile.
```
duckiter --init -b
```
#### To build image (step 2) :
To build an image from the Dockerfile that has been created in the last step, you need enter:
```
duckiter main.py --build
```
this will look for config.cfg in project directory and then build the image.
## Troubleshooting :
- if you get blow error while your docker engine is already run :
```
[ WARNNING !!!! ] It seems your docker engine doesn't run, please run the Docker engine.
```
you can fix this issue , just enter these commands :
```
$ sudo groupadd docker
$ sudo usermod -aG docker $USER
$ newgrp docker
```
now problem fixed and you can run command again.
- if you got error like :
```
duckiter : command not found
```
you can fix this issue by adding your python package directory into you PATH.
### Contribution :
feel free to contribute to this project, but first contact me about the idea :)