<div align="center">
<h1> django-DevOps </h1>
[](https://github.com/justinmerrell/django-DevOps/actions/workflows/pylint.yml)
[](https://github.com/justinmerrell/django-DevOps/actions/workflows/shellcheck.yml)
[](https://github.com/justinmerrell/django-DevOps/actions/workflows/codeql-analysis.yml)
</div>
## Table of Contents
- [Table of Contents](#table-of-contents)
- [What is django-DevOps?](#what-is-django-devops)
- [Getting Started](#getting-started)
- [Configuration Files](#configuration-files)
- [Manage Commands](#manage-commands)
- [Directory Structure](#directory-structure)
- [License](#license)
## What is django-DevOps?
The goal of this repository is to provide a set of programmatic tools to help you build and deploy your Django projects. This is done by defining best practices for the following:
- Service and Config file management
- Auto deploy from GIT
- Guided feature implementation
No more returning to the same Stackoverflow pages every time you start a new project just to remind yourself what directory config files should be placed in. All files can now be managed from a project level and quickly deployed/updated.
## Getting Started
To install the package, run the following command:
```bash
pip install django-DevOps
```
Then add `django_devoop` to your `INSTALLED_APPS` list in your `settings.py` file.
```python
INSTALLED_APPS = [
...
'django_devops',
...
]
```
For additional pip information visit: [https://pypi.org/project/django-DevOps/](https://pypi.org/project/django-DevOps/)
### Configuration Files
Under your project folder create a ```config_files``` and ```service_files``` folder to place files to be deployed.
A config file with the same name as the project will be treated as the NGINX config file and copied to site-available.
## Manage Commands
| Command | Description |
|------------------|--------------------------------------------------------------------------------------------------------|
| devops | Guided project review. (Recommended) |
| do_guide_account | Walks through the guide for user account management. |
| prep_gunicorn | Prepares the gunicorn config file for use with gunicorn. |
| prep_celery | Prepares the celery config file for use with celery. |
| prep_nginx | Prepares the nginx config file for use with nginx. |
| update_services | Similar to "collectstatic", this command will deploy config and service files from the project folder. |
## Directory Structure
```default
.
├── .github # CI/CD using GitHub Actions and other functions.
└── django_devops # Main package directory.
```
## License
This project is licensed under the terms of the [MIT license](https://opensource.org/licenses/MIT).
Raw data
{
"_id": null,
"home_page": "https://github.com/justinmerrell/django-DevOps",
"name": "django-DevOps",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "django,devops,management",
"author": "Justin Merrell",
"author_email": "merrelljustin@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/07/68/27c430e6583372da64a1647eaca0bdf802d9a6099e455779db77ea87e1cd/django-DevOps-0.2.10.tar.gz",
"platform": null,
"description": "<div align=\"center\">\n\n<h1> django-DevOps </h1>\n\n[](https://github.com/justinmerrell/django-DevOps/actions/workflows/pylint.yml)\n[](https://github.com/justinmerrell/django-DevOps/actions/workflows/shellcheck.yml) \n[](https://github.com/justinmerrell/django-DevOps/actions/workflows/codeql-analysis.yml)\n\n</div>\n\n## Table of Contents\n\n- [Table of Contents](#table-of-contents)\n- [What is django-DevOps?](#what-is-django-devops)\n- [Getting Started](#getting-started)\n - [Configuration Files](#configuration-files)\n- [Manage Commands](#manage-commands)\n- [Directory Structure](#directory-structure)\n- [License](#license)\n\n## What is django-DevOps?\n\nThe goal of this repository is to provide a set of programmatic tools to help you build and deploy your Django projects. This is done by defining best practices for the following:\n\n- Service and Config file management\n- Auto deploy from GIT\n- Guided feature implementation\n\nNo more returning to the same Stackoverflow pages every time you start a new project just to remind yourself what directory config files should be placed in. All files can now be managed from a project level and quickly deployed/updated.\n\n## Getting Started\n\nTo install the package, run the following command:\n\n```bash\npip install django-DevOps\n```\n\nThen add `django_devoop` to your `INSTALLED_APPS` list in your `settings.py` file.\n\n```python\nINSTALLED_APPS = [\n ...\n 'django_devops',\n ...\n]\n```\n\nFor additional pip information visit: [https://pypi.org/project/django-DevOps/](https://pypi.org/project/django-DevOps/)\n\n### Configuration Files\n\nUnder your project folder create a ```config_files``` and ```service_files``` folder to place files to be deployed.\n\nA config file with the same name as the project will be treated as the NGINX config file and copied to site-available.\n\n## Manage Commands\n\n| Command | Description |\n|------------------|--------------------------------------------------------------------------------------------------------|\n| devops | Guided project review. (Recommended) |\n| do_guide_account | Walks through the guide for user account management. |\n| prep_gunicorn | Prepares the gunicorn config file for use with gunicorn. |\n| prep_celery | Prepares the celery config file for use with celery. |\n| prep_nginx | Prepares the nginx config file for use with nginx. |\n| update_services | Similar to \"collectstatic\", this command will deploy config and service files from the project folder. |\n\n## Directory Structure\n\n```default\n.\n\u251c\u2500\u2500 .github # CI/CD using GitHub Actions and other functions.\n\u2514\u2500\u2500 django_devops # Main package directory.\n```\n\n## License\n\nThis project is licensed under the terms of the [MIT license](https://opensource.org/licenses/MIT).\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A Django app to manage DevOps.",
"version": "0.2.10",
"split_keywords": [
"django",
"devops",
"management"
],
"urls": [
{
"comment_text": "",
"digests": {
"md5": "a55ca80982edae110c2ec1fdf0a5cfd1",
"sha256": "99db5fb1c147d1baa062dda8a72c439f2738451edb411293a24afdae875b1620"
},
"downloads": -1,
"filename": "django_DevOps-0.2.10-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a55ca80982edae110c2ec1fdf0a5cfd1",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 12975,
"upload_time": "2022-12-01T21:06:36",
"upload_time_iso_8601": "2022-12-01T21:06:36.901765Z",
"url": "https://files.pythonhosted.org/packages/58/6b/00a754b719e5f46612e6a6a9eb1fd7ec8d89e9a5e0835888032262fdd5ee/django_DevOps-0.2.10-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"md5": "c6530de92b393a1b6f141c2bc6deacbf",
"sha256": "84aa3c70f64c4ceecf83cb06a8ace5d56f37212a93c124d7fb754aa4e36f78b7"
},
"downloads": -1,
"filename": "django-DevOps-0.2.10.tar.gz",
"has_sig": false,
"md5_digest": "c6530de92b393a1b6f141c2bc6deacbf",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 9261,
"upload_time": "2022-12-01T21:06:38",
"upload_time_iso_8601": "2022-12-01T21:06:38.723313Z",
"url": "https://files.pythonhosted.org/packages/07/68/27c430e6583372da64a1647eaca0bdf802d9a6099e455779db77ea87e1cd/django-DevOps-0.2.10.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2022-12-01 21:06:38",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "justinmerrell",
"github_project": "django-DevOps",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "django-devops"
}
JSON
