Skip to content

Commit

Permalink
Add better docstring to show the metadata attributes in the documenta…
Browse files Browse the repository at this point in the history
…tion.
  • Loading branch information
Dwight Hubbard committed Apr 28, 2015
1 parent 17f80d9 commit 587a5c3
Showing 1 changed file with 30 additions and 0 deletions.
30 changes: 30 additions & 0 deletions redislite/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,36 @@
in the module. It provides enhanced redis bindings that are able to configure
run, and cleanup a redis server when they are accessed.
Attributes:
__version__(str):
The version of the redislite module.
__redis_executable__(str):
The full path to the embedded redis-server executable.
__redis_server_version__(str):
The version of the embedded redis-server built intot he module.
__git_source_url__(str):
The github web url for the source code used to generate this module.
This will be an empty string if the module was not built from a github
repo.
__git_version__(str):
Version number derived from the number of git revisions.
This will be an empty string if not built from a git repo.
__git_origin__(str):
The git origin of the source repository the module was built from.
This will be an empty string if not built from a git repo.
__git_branch__(str):
The git branch the module was built from. This will be an empty string
if not built from a git repo.
__git_hash__(str):
The git hash value for the code used to build this module.
Example:
To access redis using a newly installed and configured redis server, then
set and retrieve some data:
Expand Down

0 comments on commit 587a5c3

Please sign in to comment.