Document generated using pydoc-markdown

Signed-off-by: Aravinda Vishwanathapura <[email protected]>

Author: aravindavk

.gitignore

@@ -8,4 +8,5 @@ pycscope.*
 build
 dist
 docs/_build
-.DS_Store
+.DS_Store
+_build

Makefile

@@ -0,0 +1,21 @@
+docgen:
+	pydocmd simple glustercli.cli.volume++ > docs/volume.md
+	pydocmd simple glustercli.cli.bitrot++ > docs/bitrot.md
+	pydocmd simple glustercli.cli.bricks++ > docs/bricks.md
+	pydocmd simple glustercli.cli.georep++ > docs/georep.md
+	pydocmd simple glustercli.cli.peer++ > docs/peer.md
+	pydocmd simple glustercli.cli.quota++ > docs/quota.md
+	pydocmd simple glustercli.cli.snapshot++ > docs/snapshot.md
+	pydocmd simple glustercli.cli.heal++ > docs/heal.md
+	pydocmd simple glustercli.cli.nfs_ganesha++ > docs/nfs_ganesha.md
+	pydocmd simple glustercli.cli.rebalance++ > docs/rebalance.md
+	pydocmd simple glustercli.cli.set_gluster_path > docs/utils.md
+	pydocmd simple glustercli.cli.set_gluster_socket >> docs/utils.md
+	pydocmd simple glustercli.cli.set_ssh_host >> docs/utils.md
+	pydocmd simple glustercli.cli.set_ssh_pem_file >> docs/utils.md
+	pydocmd simple glustercli.cli.ssh_connection >> docs/utils.md
+	pydocmd simple glustercli.cli.GlusterCmdException >> docs/utils.md
+
+	pydocmd simple glustercli.metrics.local_processes++ > docs/local_processes.md
+	pydocmd simple glustercli.metrics.local_utilization++ > docs/local_utilization.md
+	pydocmd simple glustercli.metrics.local_diskstats++ > docs/local_diskstats.md

README.md

@@ -0,0 +1,29 @@
+# glustercli-python
+
+Python bindings for [GlusterFS](http://www.gluster.org) CLI and Metrics.
+
+## Hello World
+
+```python
+from glustercli.cli import volume
+
+# Create a Volume
+volume.create("gv1", ["fvm1:/bricks/b1", "fvm2:/bricks/b2"],
+              force=True)
+
+# Start Volume
+volume.start("gv1")
+
+# Read Volume Info
+volume.info("gv1")
+```
+
+## Documentation
+
+See [Documentation](docs/README.md)
+
+Install `pydoc-markdown` package to generate Documentation.
+
+```
+sudo pip3 install pydoc-markdown
+```

README.rst

@@ -0,0 +1,21 @@
+# Python bindings for Gluster Commands and Metrics
+
+## CLI bindings
+
+* [Volume Commands](docs/volume.md)
+* [Bitrot Commands](docs/bitrot.md)
+* [Brick Commands](docs/bricks.md)
+* [Geo-replication Commands](docs/georep.md)
+* [Peer Commands](docs/peer.md)
+* [Quota Commands](docs/quota.md)
+* [Snapshot Commands](docs/snapshot.md)
+* [Heal Commands](docs/heal.md)
+* [NFS Ganesha Commands](docs/nfs_ganesha.md)
+* [Rebalance Commands](docs/rebalance.md)
+* [Utilities](docs/utils.md)
+
+## Metrics
+
+* [Local Processes](docs/local_processes.md)
+* [Local Utilization](docs/local_utilization.md)
+* [Local DiskStats](docs/local_diskstats.md)