semvec/pypi-packages huggingface dataset:
django-migration-docs 1.4.0
Sync and validate additional information about your Django migrations.
License: BSD-3-Clause
Requires Python: <4,>=3.9.0

# django-migration-docs

Migrations can be one of the most challenging aspects of deploying a Django application at scale. Depending on the size of tables and flavor of database, some migrations can easily lock some of the most important tables and bring down an application if more scrutiny isn't applied towards deployed migrations. Along with this, sometimes we must document more critical metadata about a migration before it is even deployed, such as when the migration should run in the deployment process.

`django-migration-docs` provides the ability to collect more structured information about every migration in your Django project. Along with this, it also automatically collects important metadata about migrations like the raw SQL so that more information is available for reviewers and maintainers of a large project.

When `django-migration-docs` is installed, users will be prompted for more information about migrations using a completely customizable schema that can be linted in continuous integration. The default prompt looks like the following:

![Migration Docs](docs/static/sync.gif)

Check out the [docs](https://django-migration-docs.readthedocs.io) for more information about how to use `django-migration-docs` in your application.

## Compatibility

`django-migration-docs` is compatible with Python 3.9 - 3.13 and Django 4.2 - 5.1.

## Documentation

[View the django-migration-docs docs here](https://django-migration-docs.readthedocs.io/)

## Installation

Install `django-migration-docs` with:

    pip3 install django-migration-docs
After this, add `migration_docs` to the `INSTALLED_APPS` setting of your Django project.

## Contributing Guide

For information on setting up django-migration-docs for development and contributing changes, view [CONTRIBUTING.md](CONTRIBUTING.md).

## Creators

- @juemura (Juliana de Heer)
- @wesleykendall (Wes Kendall)
- @tomage (Tómas Árni Jónasson)
detail 0.3.0
Build automations off of structured notes in your project
License: BSD-3-Clause
Requires Python: <4,>=3.9.0

# detail

`detail` allows contributors to create structured and configurable notes in a project, providing the ability to do automations such as:

1. Ensuring that contributors add information to pull requests that provide QA instructions, release notes, and associated tickets. The `detail lint` command ensures that notes are present in a pull request and adhere to the schema.

2. Rendering dynamic logs from the notes. `detail log` provides the ability to slice and dice the commit log however you need, pulling in a `notes` variable in a Jinja template with all notes that can be grouped and filtered.

3. Other automations, such as version bumping, Slack posting, ticket comments, etc can be instrumented in continuous integration from the structured notes.

When contributing a change, call `detail` to be prompted for all information defined in the project's detail schema. Information can be collected conditionally based on previous steps all thanks to the [formaldict](https://github.com/Opus10/formaldict) library.

Below is an example of a contributor creating a structured note with the type of change they are making, a summary, a description, and an associated Jira ticket:

![intro.gif](https://raw.githubusercontent.com/opus10/detail/main/docs/static/detail-intro.gif)

Notes are commited to projects, allowing review of them before they are used to perform automations in continuous integration.

## Documentation

[View the detail docs here](https://detail.readthedocs.io/).

## Installation

Install detail with:

    pip3 install detail

## Contributing Guide

For information on setting up detail for development and contributing changes, view [CONTRIBUTING.rst](CONTRIBUTING.rst).

## Creators

- @wesleykendall (Wes Kendall)
- @tomage (Tómas Árni Jónasson)