djpro 0.0.6
Package that allows you to create a Django project using a modular and scalable architecture with options like API configuration, DjangoAdminSite custom theme and Docker to optimize your development time
License: MIT
Requires Python: >=3.7

=====
djpro
=====


``djpro`` is the Python package that allows you to create a Django project
using a modular and scalable architecture with options like API configuration,
DjangoAdminSite custom theme and Docker to optimize your development time.

.. -teaser-end-

.. -overview-

The idea of this package is to facilitate the creation of a Django project with a
modular and scalable architecture, facilitating and optimizing the development time.
Through CLI commands, you will be able to include configuration options such as:
``Django Rest Framework`` configuration for further API development. ``Unfold`` setup
and configuration for a customization of the Django Admin Site theme.
``Docker`` configuration from an early stage of development to facilitate
future deployment.

Using ``djpro`` you can stop creating the directories of your Django project
from scratch.

**Feature Support**

- Fast and easy API configuration
- Automatic customization of the Django Admin Site
- Easy implementation of the production environment configuration.

.. -project-information-

Project Information
===================

``djpro`` is released under the `MIT / X11 License <https://choosealicense.com/licenses/mit/>`__,
its documentation lives at `Read the Docs <https://djpro.readthedocs.io/en/latest/>`_,
the code on `GitHub <https://github.com/szew404/djpro>`_,
and the latest release on `PyPI <https://pypi.org/project/djpro/>`_.

If you'd like to contribute to ``djpro`` you're most welcome!

.. -support-

Support
=======

Should you have any question, any remark, or if you find a bug, or if there is
something you can't do with the ``djpro``, please
`open an issue <https://github.com/szew404/djpro/issues>`_.

Contributing
============

If you would like to contribute to ``djpro``, please take a look at the
`current issues <https://github.com/szew404/djpro/issues>`_.  If there is
a bug or feature that you want but it isn't listed, make an issue and work on it.

Bug reports
-----------

*Before raising an issue, please ensure that you are using the latest version
of djpro.*

Please provide the following information with your issue to enable us to
respond as quickly as possible.

* The relevant versions of the packages you are using.
* The steps to recreate your issue.
* The full stacktrace if there is an exception.
* An executable code example where possible

Guidelines for bug reports:

* **Use the GitHub issue search** — check if the issue has already been
  reported.
* **Check if the issue has been fixed** — try to reproduce it using the latest
  ``main`` or ``develop`` branch in the repository.
* Isolate the problem — create a reduced test case and a live example.

A good bug report shouldn't leave others needing to chase you up for more
information. Please try to be as detailed as possible in your report. What is
your environment? What steps will reproduce the issue? What OS experience the
problem? What would you expect to be the outcome? All these details will help
people to fix any potential bugs.

Feature requests
----------------

Feature requests are welcome. But take a moment to find out whether your idea
fits with the scope and aims of the project. It's up to *you* to make a strong
case to convince the project's developers of the merits of this feature. Please
provide as much detail and context as possible.

Pull requests
-------------

Good pull requests - patches, improvements, new features - are a fantastic
help. They should remain focused in scope and avoid containing unrelated
commits.

Follow this process if you'd like your work considered for inclusion in the
project:

1. Check for open issues or open a fresh issue to start a discussion around a
   feature idea or a bug.
2. Fork `the repository <https://github.com/szew404/djpro>`_
   on GitHub to start making your changes to the ``develop`` branch
   (or branch off of it).
3. Write a test which shows that the bug was fixed or that the feature works as
   expected.
4. Send a pull request and bug the maintainer until it gets merged and published.

If you are intending to implement a fairly large feature we'd appreciate if you
open an issue with GitHub detailing your use case and intended solution to
discuss how it might impact other work that is in flight.

We also appreciate it if you take the time to update and write tests for any
changes you submit.

**By submitting a patch, you agree to allow the project owner to license your
work under the same license as that used by the project.**

Resources
---------

* `How to Contribute to Open Source <https://opensource.guide/how-to-contribute/>`_
* `Using Pull Requests <https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests>`_
* `Writing good commit messages <https://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html>`_

Release Information
===================



`Full changelog <https://djpro.readthedocs.io/en/latest/index.html/en/latest/changelog.html>`_.

Security Policy
===============


Reporting a Vulnerability
-------------------------

If you discover a security vulnerability within ``djpro``, please
send an e-mail to Franco Gidaszewski via gidaszewskifranco@gmail.com. All security
vulnerabilities will be promptly addressed.

Credits
=======

``djpro`` was created by `Franco Gidaszewski <https://github.com/szew404>`_.

Acknowledgments
===============

The existence of ``djpro`` would have been impossible without these
projects:

- `django <https://github.com/django/django>`_
- `joke2k/django-environ <https://github.com/joke2k/django-environ>`_
- `encode/django-rest-framework <https://github.com/encode/django-rest-framework>`_
- `unfoldadmin/django-unfold <https://github.com/unfoldadmin/django-unfold>`_