Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
[![PyPI Downloads](https://static.pepy.tech/badge/that-depends/month)](https://pepy.tech/projects/that-depends)
[![GitHub stars](https://img.shields.io/github/stars/modern-python/that-depends)](https://github.com/modern-python/that-depends/stargazers)
[![libs.tech recommends](https://libs.tech/project/773446541/badge.svg)](https://libs.tech/project/773446541/that-depends)

[![llms.txt](https://img.shields.io/badge/llms.txt-green)](https://that-depends.readthedocs.io/llms.txt)
Dependency injection framework for Python.

It is production-ready and gives you the following:
Expand Down
6 changes: 6 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,3 +67,9 @@ await some_foo() # "async resource"
```

See the [injection documentation](introduction/injection.md) for more information.

## llms.txt

`that-depends` provides a [llms.txt](https://that-depends.readthedocs.io/llms.txt) file.

You can find documentation on how to use it [here](https://llmstxt.org/).
37 changes: 37 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -96,6 +96,43 @@ markdown_extensions:

extra_css:
- css/code.css
plugins:
- llmstxt:
full_output: llms-full.txt
markdown_description: "A simple dependency injection framework for Python."
sections:
Quickstart:
- index.md: How to install and basic usage example
Containers:
- introduction/ioc-container.md: Defining the DI Container
- introduction/multiple-containers.md: Using multiple DI Containers
Injecting Dependencies:
- introduction/injection.md: Default way to inject dependencies
- introduction/generator-injection.md: Injecting dependencies into generators
- introduction/type-based-injection.md: Injecting dependencies by bound type
- introduction/string-injection.md: Injecting dependencies by providing a reference to a Provider by string
Simple Providers:
- providers/singleton.md: The Singleton and AsyncSingleton provider
- providers/factories.md: The Factory and AsyncFactory provider
- providers/object.md: The Object provider
- providers/resources.md: The Resource and AsyncResource provider
- introduction/tear-down.md: Handling tear down for Singletons and Resources
Context Providers:
- providers/context-resources.md: The ContextResource provider
- introduction/scopes.md: Handling scopes with ContextResources
- providers/state.md: The State provider
Providers that interact with other providers:
- providers/collections.md: The Dict and List provider
- providers/selector.md: The Selector provider
Integrations with other Frameworks:
- integrations/fastapi.md: Integration with FastApi
- integrations/faststream.md: Integration with FastStream
- integrations/litestar.md: Integration with LiteStar
Testing:
- testing/fixture.md: Usage with fixtures
- testing/provider-overriding.md: Overriding providers
Experimental features:
- experimental/lazy.md: The Lazy provider

extra:
social:
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -42,11 +42,11 @@ dev = [
"mypy",
"typing-extensions",
"pre-commit",
# integrations tests
"litestar",
"faststream[nats]",
"mkdocs>=1.6.1",
"pytest-randomly",
"mkdocs-llmstxt>=0.4.0",
]

[build-system]
Expand Down