File: index.rst

package info (click to toggle)
python-polyfactory 2.22.2-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 1,892 kB
  • sloc: python: 11,338; makefile: 103; sh: 37
file content (128 lines) | stat: -rw-r--r-- 3,720 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
:layout: landing
:description: Polyfactory is a simple and powerful mock data generation library.

.. container::
    :name: home-head

    .. image:: //usr/share/doc/python-polyfactory-doc/html/_static/logo.svg
        :alt: Litestar Framework
        :width: 400
        :height: 400

    .. container::

        .. raw:: html

            <h1>Polyfactory</h1>

        .. container:: badges
           :name: badges

.. rst-class:: lead

   Polyfactory is a simple and powerful mock data generation library, based around type
   hints and supporting :doc:`dataclasses <python:library/dataclasses>`, :class:`TypedDicts <typing.TypedDict>`,
   Pydantic models, :class:`msgspec Struct's <msgspec.Struct>` and more.

.. container:: buttons

    :doc:`Get Started <getting-started>`
    `Usage Docs <usage>`_
    `API Docs <reference>`_
    `Blog <https://blog.litestar.dev>`_

.. grid:: 1 1 2 2
    :padding: 0
    :gutter: 2

    .. grid-item-card:: :octicon:`versions` Changelog
      :link: changelog
      :link-type: doc

      The latest updates and enhancements to Polyfactory

    .. grid-item-card:: :octicon:`comment-discussion` Discussions
      :link: https://github.com/litestar-org/polyfactory/discussions

      Join discussions, pose questions, or share insights.

    .. grid-item-card:: :octicon:`issue-opened` Issues
      :link: https://github.com/litestar-org/polyfactory/issues

      Report issues or suggest new features.

    .. grid-item-card:: :octicon:`beaker` Contributing
      :link: contribution-guide
      :link-type: doc

      Contribute to Litestar's growth with code, docs, and more.

Sponsors
--------

.. rst-class:: lead

   Litestar is a community-driven, open-source initiative that thrives on the generous contributions of our sponsors,
   enabling us to pursue innovative developments and continue our mission to provide exceptional tools and resources
   to our users.


A huge thank you to our current sponsors:

.. container::
   :name: sponsors-section

   .. grid:: 3
      :class-row: surface
      :padding: 0
      :gutter: 2

      .. grid-item-card::
         :link: https://github.com/scalar/scalar

         .. image:: //usr/share/doc/python-polyfactory-doc/html/_static/scalar.svg
            :alt: Scalar.com
            :class: sponsor

         `Scalar.com <https://github.com/scalar/scalar>`_

      .. grid-item-card::
         :link: https://telemetrysports.com/

         `Telemetry Sports <https://telemetrysports.com/>`_

      .. grid-item-card::
         :link: https://www.stok.kr/

         `Stok <https://www.stok.kr/>`_

We invite organizations and individuals to join our sponsorship program.
By becoming a sponsor on platforms like `Polar <sponsor-polar_>`_, `GitHub <sponsor-github_>`_
and `Open Collective <sponsor-oc_>`_, you can play a pivotal role in our project's growth.

On top of regular sponsorship, we engage in pledge-based sponsorship opportunities through `Polar <sponsor-polar_>`_,
where you can pledge an amount towards an issue or feature you would like to see implemented.


.. _sponsor-github: https://github.com/sponsors/litestar-org
.. _sponsor-oc: https://opencollective.com/litestar
.. _sponsor-polar: https://polar.sh/litestar-org

.. toctree::
    :titlesonly:
    :caption: Documentation
    :hidden:

    getting-started
    usage/index
    reference/index

.. toctree::
    :titlesonly:
    :caption: Contributing
    :hidden:

    changelog
    contribution-guide
    Available Issues <https://github.com/search?q=user%3Alitestar-org+state%3Aopen+label%3A%22good+first+issue%22+++no%3Aassignee+repo%3A%22polyfactory%22&type=issues>
    Code of Conduct <https://github.com/litestar-org/.github?tab=coc-ov-file#readme>