File: api.rst

package info (click to toggle)
diceware 1.0.1-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 1,252 kB
  • sloc: python: 1,513; makefile: 165; sh: 10
file content (59 lines) | stat: -rw-r--r-- 1,041 bytes parent folder | download | duplicates (4)
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
API
===

`diceware` code is geared towards commandline usage. You can, however,
use it from Python. The API docs are here to assist you with that.

For using `diceware` in your own, `setuptools`-based Python project,
you can add it as an install requirement in ``setup.py`` of your
project::

  from setuptools import setup
  # ...
  setup(
      name="myproject",
      # ...
      install_requires=[
          #  packages we depend on...
          'setuptools',
          'diceware',
          # ...
      ],
      # ...
  )

Of course there are other ways to make `diceware` available.


`diceware` main module
----------------------

.. automodule:: diceware
   :members:

`diceware.logger`
-----------------

.. automodule:: diceware.logger
   :members:


`diceware.config`
-----------------

.. automodule:: diceware.config
   :members:


`diceware.wordlist`
-------------------

.. automodule:: diceware.wordlist
   :members:


`diceware.random_sources`
-------------------------

.. automodule:: diceware.random_sources
   :members: