Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix syntax problems in README that block upload to PyPI #264

Merged
merged 2 commits into from
May 25, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 13 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,35 +18,40 @@ https://jenkins1.ugent.be/job/vsc-base-python26/Documentation/
## lib/utils
python utilities to be used as libraries

- __fancylogger__: an extention of the default python logger designed to be easy to use and have a
couple of `fancy` features.
- __fancylogger__: an extention of the default python logger designed to be easy to use and have a couple of `fancy` features.

- custom specifiers for mpi loggin (the mpirank) with autodetection of mpi
- custom specifier for always showing the calling function's name
- rotating file handler
- a default formatter.
- logging to an UDP server (logdaemon.py f.ex.)
- easily setting loglevel

- __daemon.py__ : Daemon class written by Sander Marechal (http://www.jejik.com) to start a python script as a daemon.
- __missing.py__: Small functions and tools that are commonly used but not
available in the Python (2.x) API.
- __missing.py__: Small functions and tools that are commonly used but not available in the Python (2.x) API.
- ~~__cache.py__ : File cache to store pickled data identified by a key accompanied by a timestamp.~~ (moved to [vsc-utils](https://github.com/hpcugent/vsc-utils))
- __generaloption.py__ : A general option parser for python. It will fetch options (in this order) from config files, from environment variables and from the command line and parse them in a way compatible with the default python optionparser. Thus allowing a very flexible way to configure your scripts.
It also adds a few other useful extras.
- __generaloption.py__ : A general option parser for python. It will fetch options (in this order) from config files, from environment variables and from the command line and parse them in a way compatible with the default python optionparser. Thus allowing a very flexible way to configure your scripts. It also adds a few other useful extras.
- __affinity.py__ : Linux cpu affinity.

- Based on `sched.h` and `bits/sched.h`,
- see man pages for `sched_getaffinity` and `sched_setaffinity`
- also provides a `cpuset` class to convert between human readable cpusets and the bit version Linux priority
- Based on sys/resources.h and bits/resources.h see man pages for `getpriority` and `setpriority`

- __asyncprocess.py__ : Module to allow Asynchronous subprocess use on Windows and Posix platforms

- Based on a [python recipe](http://code.activestate.com/recipes/440554/) by Josiah Carlson
- added STDOUT handle and recv_some

- __daemon.py__ : [A generic daemon class by Sander Marechal](http://www.jejik.com/articles/2007/02/a_simple_unix_linux_daemon_in_python/)
- __dateandtime.py__ : A module with various convenience functions and classes to deal with date, time and timezone.
- __nagios.py__ : This module provides functionality to cache and report results of script executions that can readily be
interpreted by nagios/icinga.
- __nagios.py__ : This module provides functionality to cache and report results of script executions that can readily be interpreted by nagios/icinga.
- __run.py__ : Python module to execute a command, can make use of asyncprocess, answer questions based on a dictionary

- supports a whole lot of ways to input, process and output the command. (filehandles, PIPE, pty, stdout, logging...)

- __mail.py__ : Wrapper around the standard Python mail library.

- Send a plain text message
- Send an HTML message, with a plain text alternative

Expand Down
3 changes: 1 addition & 2 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@
]

PACKAGE = {
'version': '2.7.1',
'version': '2.7.2',
'author': [sdw, jt, ag, kh],
'maintainer': [sdw, jt, ag, kh],
# as long as 1.0.0 is not out, vsc-base should still provide vsc.fancylogger
Expand All @@ -55,7 +55,6 @@
},
'setup_requires': ['vsc-install >= %s' % VSC_INSTALL_REQ_VERSION],
'tests_require': ['prospector'] + _coloredlogs_pkgs,
'long_description_content_type': 'text/markdown',
}

if __name__ == '__main__':
Expand Down