Skip to content

Commit 52231bb

Browse files
committed
Update README files
1 parent 60a199c commit 52231bb

File tree

10 files changed

+23
-24
lines changed

10 files changed

+23
-24
lines changed

source-code/cmd/README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
11
# Cmd
2+
23
Standard Python library framework to facilitate writing command line
34
driven interpreters.
45

56
## What is it?
7+
68
1. `simple.py`: a very simmple example that keeps track of a list of
79
friends. A friend is added by saying `hi` to her, and is removed by
810
saying `bye` to her. You can't say `hi` to someone who is your friend

source-code/code-evaluation/README.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,11 @@
1-
EvaluateCode
2-
============
1+
# Code evaluation
32

43
Python allows executino of Python source code at runtime. Although this
54
is a powerful feature, it should be used with extreme care, since it can
65
give rise to serious security issues.
76

8-
What is it?
9-
-----------
7+
## What is it?
8+
109
1. `evaluate.py`: short example that reads a code fragment, evaluates it,
1110
and prints all values of variables defined in that code fragment.
1211
Only variables of type `int`, '`float`, `str`, `bool` and `list` will

source-code/command-line-arguments/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# CommandLineArgs
1+
# Command line arguments
22

33
How to handle command line arguments in Python scripts.
44

source-code/config-parser/README.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,10 @@
1-
ConfigParser
2-
============
1+
# ConfigParser
32

43
ConfigParser is a module in Python's standard library to handle
54
configuration files easily.
65

7-
What is it?
8-
-----------
6+
## What is it?
7+
98
1. `config_reader.py`: reads a configuration file provided on the command
109
line, or `default.conf`. It prints the sections of the configuration
1110
files, and the key/value pairs defined therein.

source-code/file-system/README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
1-
# OsFileSystem
1+
# File system
2+
23
Examples of code interacting with the operating system or performing
34
file system operations.
45

source-code/hydra/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ It support configuration file handling, command line arguments, logging,
77
multiruns and so on.
88

99
## What is it?
10+
1011
1. `gen_rand.py`: Python script to write random numbers to standard
1112
output.
1213
1. `conf/`: directory containing the configuration files.

source-code/logging/README.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,10 @@
1-
Logging
2-
=======
1+
# Logging
32

43
Using logging facilities rather than print or sys.stderr.write calls
54
adds a lot of flexibility to more complex programs. These facilities
65
are provided through Python's standard library.
76

8-
What is it?
9-
-----------
7+
## What is it?
8+
109
`log_it_all.py`: illustration of how to use the default logging mechanisms,
1110
how to set the log level the destination, and the log format
12-

source-code/paramiko/README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
11
# Paramiko
2+
23
Paramiko is a non-standard Python library for working with SSH. It can
34
be used to execute command on a remote host, or perform file transfers
45
using the SFTP protocol.
56

67
## What is it?
8+
79
1. `ssh.py`: module with some SSH connection utitlity functions, imported
810
in the scripts.
911
1. `ls.py`: performs an `ls` command for the specified directory on a

source-code/subprocess/README.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,12 @@
1-
Executing external programs or shell commands
2-
=============================================
1+
# Executing external programs or shell commands
32

43
Executing external programs or shell commands can conveniently be done
54
using Python's `subprocess` module in the standard library. It allows
65
to send input to the external command (if necessary), and capture
76
what is sent to standard output and/or standard error by that command.
87
The exit code can also be retrieved.
98

10-
What is it?
11-
-----------
9+
## What is it?
10+
1211
`wc_metrics.py`: this script computes the number of characters, words, and
1312
lines in a file using the shell's `wc` commaand.
14-

source-code/xml-generator/README.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,9 @@
1-
XmlGenerator
2-
============
1+
# XML generator
32

43
Generates random XML documents, the number of different tags, the number
54
of elements, whether or not the elements contain text, as well as their
65
length can all be configured.
76

8-
What is it?
9-
-----------
7+
## What is it?
8+
109
1. `gen_xml.py`: generator for random XML documents.

0 commit comments

Comments
 (0)