Skip to content

Commit

Permalink
Add further detail to README and the project description.
Browse files Browse the repository at this point in the history
  • Loading branch information
jacklinke committed Nov 24, 2024
1 parent 481800d commit e654041
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 1 deletion.
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -261,6 +261,14 @@ We welcome contributions! This project uses:
- [Cookiecutter](https://github.com/audreyr/cookiecutter)
- [cookiecutter-djangopackage](https://github.com/pydanny/cookiecutter-djangopackage)
- [rich](https://github.com/willmcgugan/rich/)
- [graphviz](https://graphviz.org/)
- [MermaidJS](https://mermaid-js.github.io/mermaid/)
- [networkx](https://networkx.org/)
- [pydot](https://pypi.org/project/pydot/)

## Background and Credits

The `modelinfo` command has been something I have slowly been working on and improving for several years. The original idea behind `modelfilters` came from observing the underlying functionality in the `django-drip-campaigns` package and realizing that having a way to list potential filter paths could help developers with building complex queries, though my implementation of those ideas is quite different. The `modelgraph` command was loosely inspired by existing tools like the `graph_models` command in `django-extensions`, but I wanted to provide a more detailed, filterable, and customizable output. The `migrationgraph` command was inspired by recent discussions I read online about migration graphs and dependencies, but I cannot recall the specific thread/post that sparked the idea.

## License

Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ build-backend = "setuptools.build_meta"
[project]
name = "django-model-info"
version = "2024.11.4"
description = "A Django app to provide information about models"
description = "A set of Django Management Commands to help you understand and visualize your project's models."
authors = [{ name = "Jack Linke", email = "[email protected]" }]
license = { text = "MIT" }
readme = "README.md"
Expand Down

0 comments on commit e654041

Please sign in to comment.