Skip to content
Snippets Groups Projects
Commit 2ff24021 authored by ulif's avatar ulif
Browse files

Add API docs.

parent 201082bd
No related branches found
No related tags found
No related merge requests found
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.wordlist`
-------------------
.. automodule:: diceware.wordlist
:members:
`diceware.random_sources`
-------------------------
.. automodule:: diceware.random_sources
:members:
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment