Skip to content
GitLab
Explore
Sign in
Register
Primary navigation
Search or go to…
Project
D
diceware-debian
Manage
Activity
Members
Labels
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Deploy
Releases
Model registry
Analyze
Value stream analytics
Contributor analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
drebs
diceware-debian
Commits
ee371ea7
Commit
ee371ea7
authored
10 years ago
by
ulif
Browse files
Options
Downloads
Patches
Plain Diff
Update docs.
parent
149cde79
No related branches found
Branches containing commit
No related tags found
Tags containing commit
No related merge requests found
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
README.rst
+59
-2
59 additions, 2 deletions
README.rst
with
59 additions
and
2 deletions
README.rst
+
59
−
2
View file @
ee371ea7
...
...
@@ -136,6 +136,59 @@ The Python API of this package allows usage of other sources of
randomness when generating passphrases.
Developer Install
-----------------
Developers want to `fork me on github`_::
$ git clone https://github.com/ulif/diceware.git
We recommend to create and activate a virtualenv_ first::
$ cd diceware/
$ virtualenv -p /usr/bin/python3.3 py33
$ source py33/bin/activate
(py33) $
We support Python versions 2.6, 2.7, 3.2, 3.3, 3.4, pypy.
Now you can create the devel environment::
(py33) $ python setup.py dev
This will fetch test packages (py.test_). You should be able to run
tests now::
(py33) $ py.test
If you have also different Python versions installed you can use tox_
for using them all for testing::
(py33) $ pip install tox # only once
(py33) $ tox
Should run tests in all supported Python versions.
Documentation Install
.....................
The docs can be generated with Sphinx_. The needed packages are
installed via::
(py33) $ python setup.py docs
To create HTML you have to go to the ``docs/`` directory and use the
prepared ``Makefile``::
(py33) $ cd docs/
(py33) $ make
This should generate the docs in ``docs/_build/html/``.
Credits
-------
...
...
@@ -146,7 +199,7 @@ Links
-----
- The Diceware_ home page. Reading definitely recommended!
- `
F
ork me on github`_
- `
f
ork me on github`_
Wordlists:
...
...
@@ -166,5 +219,9 @@ Copyright by Arnold G. Reinhold. See file LICENSE for details.
.. _pip: https://pip.pypa.io/en/latest/
.. _`Diceware8k list`: http://world.std.com/~reinhold/diceware8k.txt
.. _`Diceware`: http://diceware.com/
.. _`
F
ork me on github`: http://github.com/ulif/diceware/
.. _`
f
ork me on github`: http://github.com/ulif/diceware/
.. _`random.SystemRandom`: https://docs.python.org/3.4/library/random.html#random.SystemRandom
.. _virtualenv: https://virtualenv.pypa.io/
.. _py.test: https://pytest.org/
.. _tox: https://tox.testrun.org/
.. _Sphinx: https://sphinx-doc.org/
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment