# HiDjango
HiDjango is a Python library designed to simplify the initialization and setup of Django projects, enabling developers to create Django projects with DevOps configurations using a single command.
## Features
- Initialize Django projects with a single command.
- Automatically add Docker and Docker Compose files for development.
- Configure databases (PostgreSQL or MySQL) with minimal effort.
- Easy-to-use CLI for managing Django projects.
## Installation
To install HiDjango, use pip:
```bash
pip install hidjango
```
## Usage
### Creating a Django Project
To create a new Django project:
```bash
hidjango --init --name="project_name"
```
This command creates a new Django project with the specified name.
### Adding DevOps Files
To include Docker and Docker Compose files:
```bash
hidjango --init --name="project_name" --devops
```
This adds the following files to your project:
- `Dockerfile`
- `docker-compose.yml`
### Configuring a Database
If a database is set, its configuration will be added to the `settings.py` file of the Django project automatically.
#### PostgreSQL Example:
```bash
hidjango --init --name="project_name" --db=postgresql
```
#### MySQL Example:
```bash
hidjango --init --name="project_name" --db=mysql
```
If the `--devops` flag is included, the database configuration will also be added to the `docker-compose.yml` file.
## Requirements
- Python 3.7 or higher
- Django 3.2 or higher
## Example Commands
### Full Setup with DevOps and Database
```bash
hidjango --init --name="my_project" --devops --db=postgresql
```
This command:
1. Creates a new Django project named `my_project`.
2. Adds `Dockerfile` and `docker-compose.yml`.
3. Configures the project to use PostgreSQL as its database.
## Contributing
We welcome contributions! To contribute:
1. Fork the repository on GitHub.
2. Make your changes.
3. Open a pull request.
For issues or feature requests, please open an issue on [GitHub](https://github.com/parsarezaee/HiDjango/issues).
## License
This project is licensed under the MIT License. See the LICENSE file for details.
## Links
- [GitHub Repository](https://github.com/parsarezaee/HiDjango)
- [PyPI Package](https://pypi.org/project/hidjango/)
---
Raw data
{
"_id": null,
"home_page": "https://github.com/parsarezaee/HiDjango",
"name": "hidjango",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": "django library project automation devops",
"author": "Parsa Rezaei",
"author_email": "rezaei.7parsa@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/8d/81/87d3a6bc05a436da026970573f552854fbb095b7bc642643043d88e558b4/hidjango-1.0.0.tar.gz",
"platform": null,
"description": "# HiDjango\n\nHiDjango is a Python library designed to simplify the initialization and setup of Django projects, enabling developers to create Django projects with DevOps configurations using a single command.\n\n## Features\n- Initialize Django projects with a single command.\n- Automatically add Docker and Docker Compose files for development.\n- Configure databases (PostgreSQL or MySQL) with minimal effort.\n- Easy-to-use CLI for managing Django projects.\n\n## Installation\nTo install HiDjango, use pip:\n\n```bash\npip install hidjango\n```\n\n## Usage\n\n### Creating a Django Project\nTo create a new Django project:\n\n```bash\nhidjango --init --name=\"project_name\"\n```\n\nThis command creates a new Django project with the specified name.\n\n### Adding DevOps Files\nTo include Docker and Docker Compose files:\n\n```bash\nhidjango --init --name=\"project_name\" --devops\n```\n\nThis adds the following files to your project:\n- `Dockerfile`\n- `docker-compose.yml`\n\n### Configuring a Database\nIf a database is set, its configuration will be added to the `settings.py` file of the Django project automatically.\n\n#### PostgreSQL Example:\n```bash\nhidjango --init --name=\"project_name\" --db=postgresql\n```\n\n#### MySQL Example:\n```bash\nhidjango --init --name=\"project_name\" --db=mysql\n```\n\nIf the `--devops` flag is included, the database configuration will also be added to the `docker-compose.yml` file.\n\n## Requirements\n- Python 3.7 or higher\n- Django 3.2 or higher\n\n## Example Commands\n\n### Full Setup with DevOps and Database\n```bash\nhidjango --init --name=\"my_project\" --devops --db=postgresql\n```\n\nThis command:\n1. Creates a new Django project named `my_project`.\n2. Adds `Dockerfile` and `docker-compose.yml`.\n3. Configures the project to use PostgreSQL as its database.\n\n## Contributing\nWe welcome contributions! To contribute:\n1. Fork the repository on GitHub.\n2. Make your changes.\n3. Open a pull request.\n\nFor issues or feature requests, please open an issue on [GitHub](https://github.com/parsarezaee/HiDjango/issues).\n\n## License\nThis project is licensed under the MIT License. See the LICENSE file for details.\n\n## Links\n- [GitHub Repository](https://github.com/parsarezaee/HiDjango)\n- [PyPI Package](https://pypi.org/project/hidjango/)\n\n---\n\n\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A library to simplify Django project initialization",
"version": "1.0.0",
"project_urls": {
"Homepage": "https://github.com/parsarezaee/HiDjango"
},
"split_keywords": [
"django",
"library",
"project",
"automation",
"devops"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "9aca02b27914f283f43ce31e30725fc1d2df656b23ac5b8b605575fef3e069e3",
"md5": "ae2ec699c3ef256d92b271ba7dfd855c",
"sha256": "633adb0e8bf20c21bdf82054be1037291c5b3bc3bc3f20b89ede82ccd4c3eb48"
},
"downloads": -1,
"filename": "hidjango-1.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ae2ec699c3ef256d92b271ba7dfd855c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 5705,
"upload_time": "2024-11-24T17:02:06",
"upload_time_iso_8601": "2024-11-24T17:02:06.622613Z",
"url": "https://files.pythonhosted.org/packages/9a/ca/02b27914f283f43ce31e30725fc1d2df656b23ac5b8b605575fef3e069e3/hidjango-1.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "8d8187d3a6bc05a436da026970573f552854fbb095b7bc642643043d88e558b4",
"md5": "e9d2ccfa1ba885d9773530eed6985a95",
"sha256": "b10caa8ae641426afad6f884e6507016deda25b02b3fe604cf8aec597479b9a1"
},
"downloads": -1,
"filename": "hidjango-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "e9d2ccfa1ba885d9773530eed6985a95",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 5018,
"upload_time": "2024-11-24T17:02:08",
"upload_time_iso_8601": "2024-11-24T17:02:08.253754Z",
"url": "https://files.pythonhosted.org/packages/8d/81/87d3a6bc05a436da026970573f552854fbb095b7bc642643043d88e558b4/hidjango-1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-24 17:02:08",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "parsarezaee",
"github_project": "HiDjango",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "hidjango"
}
JSON
