Functions

Summary

function class parent truncated documentation
IsJuliaInstalled    
IsPandocInstalled    
IsPuttyInstalled   check if Scite was already installed
IsRInstalled    
IsSQLiteSpyInstalled   Checks if SQLiteSpy was already installed
IsSciteInstalled   check if Scite was already installed
_build_reverse_index   builds a reverse index of the module,
_build_set_correspondance   builds a dictionary which returns a dictionary { name: function_set }.
_cg_dl   compressed
_cg_dl1    
_clean_page_wheel   remove unexpected characters
_function_set_name   return the name of a function (not the module)
_get_pypi_version_memoize_op    
_is_package_in_list   determines of this package is the one for the given module_name
_main_pipdeptree   The function relies on module pipdeptree.main.
_setup_hook   does nothing
add_kernel_jupyter   add a kernel to jupyter
add_shortcut   Adds a shortcut to the desktop.
add_shortcut_to_desktop   add_shortcut()
add_shortcut_to_desktop_for_ipython   create a shortcut on your desktop
add_shortcut_to_desktop_for_module   Adds a shortcut on a module which includes a script.
add_shortcut_to_desktop_for_scite   create a shortcut on your desktop
add_shortcut_to_desktop_for_sqlitespy   create a shortcut on your desktop
all_set   Installation of all possible modules listed in this module.
architecture    
bootstrap    
build_requirements   builds a requirements list based on a list of ModuleInstall
build_venv_cmd   builds the command line for virtual env
call_get_installed_distributions   Directs call to function get_installed_distributions from pip. Return a list of installed Distribution objects. …
check   Checks the library is working. It raises an exception. If you want to disable the logs:
check_sys_path   An issue is happening during unit test as pymyinstall could be imported from two locations. We check this is not …
choose_most_recent   Chooses the most recent version for a list of module names.
classifiers2string   shorten the list of classifiers into a string
clean_msi   clean all files follwing a specific pattern
cloud_set   modules introduced by students or needed for student projects, it requires the modules in set extended
compare_version   Compares two versions.
copy_icons   copy all files from src to dest
copy_tutorial   copy files and scripts for a specific tutorial
create_empty_folder_setup   Creates a quick empty shell for a new project.
create_folder_setup   Creates a quick setup for an existing or installed projects.
create_links_tools   create links for the tools
create_shortcut   Create Windows shortcut (.lnk file)
create_virtual_env    
create_win_batches   create batchs for the setup, they will be placed in folders[“config”]
create_win_env   create a batch file to set up the environment
create_win_glue   create a batch file to start Glue
create_win_julia_console   create a batch file to start julia
create_win_jupyter_console   create a batch file to start jupyter
create_win_jupyter_notebook   create a batch file to start Jupyter Notebook
create_win_jupyter_qtconsole   create a batch file to start Jupyter QtConsole
create_win_orange   create a batch file to start orange
create_win_putty   create a batch file to start scite
create_win_python_console   create a batch file to start python
create_win_r_console   create a batch file to start R
create_win_r_gui   create a batch file to start R Gui
create_win_rss   create a batch file to start RSS reader
create_win_scite   create a batch file to start scite
create_win_spyder   create a batch file to start spyder
create_win_sqlite_bro   create a batch file to start SqliteBro
create_win_sqllitespy   create a batch file to start sqlitespy
datascientistbase_set   list of modules to add to python to get a minimal python
decode_fs_string   Convert string from file system charset to unicode
decode_outerr   decode the output or the error after running a command line instructions
distribution_checkings   checks a distribution was properly executed
do_main   calls function missing_dependencies()
do_main   calls function install_all() but is meant to be added to scripts folder
do_main   Calls function update_all() but is meant to be added to scripts folder.
do_main   calls function update_all() but is meant to be added to scripts folder
do_script   Execute a script (get-pip typically)
download_file   Downloads a file from a url, the function does not download the file again if outfile already exists.
download_from_sourceforge   Downloads a file from a url using redirection, the function does not download the file again if outfile already …
download_module   Downloads the module without installation.
download_revealjs   Download reveal.js release. and unzip it.
dtnow   shortcut, return datetime.datetime.now()
ensae_fullset   Installation of all possible modules for my teachings at the ENSAE.
ensae_set   modules introduced by students or needed for student projects, it requires the modules in set extended
enumerate_links_module   Selects the links for a specific module.
exec_shell_cmd   Execute shell command (args is a list of arguments) in path
extended_set   list of modules to install, an rich set, to work with data and more, it requires the modules in set small
extract_all_links   parses HTML to extract all links
extract_archive   Extract .zip, .exe (considered to be a zip archive) or .tar.gz archive to a temporary directory (if targetdir is None). …
extract_copy   Copy .exe to targetdir
extract_exe   Extract .exe archive to a temporary directory (if targetdir is None). Return the temporary directory path
extract_msi   Extract .msi installer to a temporary directory (if targetdir is None). Return the temporary directory path
find_innosetup   find InnoSetup executable
find_module_install   Checks if there are specific instructions to run before installing module name, on Windows, some modules requires …
fix_fcntl_windows   Adds a file fnctl.py on Windows (only available on Linux).
fix_pywin32_installation   copy DLL at the right place
fix_resource_windows   Adds a file resource.py on Windows (only available on Linux).
fix_scipy10_for_statsmodels08   scipy deprecated some functions still used by statsmodels 0.8. See deprecated features
fix_termios_windows   Adds a file termios.py on Windows (only available on Linux).
fix_win32ctypes_core_cffi__advapi32_py   Fixes the following issue:
folder_older_than   Tells if a folder is older than a given timespan.
get_R_version   returns the version of installed R, we only focus on the x64 version
get_conda_program   Gets conda executable and fixes an issue with Pandoc.
get_default_ignore_modules   A couple of modules have some dependencies on not supported modules or modules integrated to the standard distributiion …
get_env   Return HKCU/HKLM environment variable name and value
get_file_modification_date   Gets the date modification for a filename.
get_gcc_version   Return version of the GCC compiler installed in path
get_install_list   returns the list of tools a developper might need
get_installed_modules   Returns all modules recored in this modules. Adds installed modules.
get_interpreter_path   return the interpreter path
get_julia_version   returns the version of installed R, we only focus on the x64 version
get_julia_version   Return version of the Julia installed in path
get_module_dependencies   Returns the dependencies for a module.
get_module_metadata   Returns a dictionary { module: metadata }.
get_module_version   Returns a dictionary { module: version }.
get_modules_version   return a dictionary { module:version }
get_package_description   returns the description of an R package as a dictionary
get_package_set   return a list of modules included in one the functions imported in this module
get_parser   defines the way to parse the script pymy_deps
get_parser   defines the way to parse the script pymy_install
get_parser   defines the way to parse the script pymy_status
get_parser   defines the way to parse the script pymy_update
get_pip_program   Gets pip executable and fixes an issue with Pandoc.
get_pypi_version   Returns the version of a package on pypi, we skip alpha, beta or dev version.
get_python_infos   Return (version, architecture) for the Python distribution located in path. The version number is limited to MAJOR.MINOR, …
get_python_long_version   Return long version (X.Y.Z) for the Python distribution located in path
get_python_program   Returns the executable for python.
get_r_version   Return version of the R installed in path
get_source_package_infos   Return a tuple (name, version) of the Python source package
get_wheel_version   extract the version from a wheel file, return 2.6.0 for rpy2-2.6.0-cp34-none-win_amd64.whl
has_pip   Tells if pip is installed.
import_every_module   import every module in module_list assuming they are defined by ModuleInstall or a string
import_pywin32   For the module pywin32, this function tries to add the path to the DLL to PATH before throwing the exception: …
inno_install_kernels   install kernels for Jupyter notebooks
innosetup_replacements   run InnotSetup for a script
install_7z   Install 7z. It does not do it a second time if it is already installed.
install_R   Install R. It does not do it a second time if it is already installed.
install_all   Installs modules in list_module if None, this list will be returned by ensae_fullset(), the function starts …
install_chromedriver   Installs chromedriver.
install_git   Install Git. It does not do it a second time if it is already installed.
install_graphviz   Install Graphviz. It does not do it a second time if it is already installed.
install_inkscape   Installs InkScape (only on Windows).
install_javajdk   Install Java JDK.
install_jenkins   install Jenkins (only on Windows)
install_julia   Install R. It does not do it a second time if it is already installed.
install_jupyter_extension   install jupyter extension
install_kernels   install available kernels on Windows
install_mathjax   install a local copy of mathjax
install_memoize   cache a downloaded page
install_memoize2   cache a downloaded page
install_miktex   install MikTex (only on Windows)
install_mingw   install MinGW (only on Windows)
install_module   Installs a module.
install_module_deps   Installs a module with its dependencies, if a module is already installed, it installs the missing dependencies. …
install_operadriver   Installs operadriver.
install_pandoc   Install pandoc. It does not do it a second time if it is already installed.
install_putty   install Putty (only on Windows)
install_python   Installs python. It does not do it a second time if it is already installed.
install_scala_sbt   Install scala-sbt. It does not do it a second time if it is already installed. …
install_scite   install SciTE (only on Windows)
install_sqlitespy   Installs SQLiteSpy. It does not do it a second time if it is already installed.
install_tdm_gcc   install TDM-GCC (only on Windows)
install_vs   install Visual Studio Express (only on Windows) …
iot_set   list of sphinx themes and others helpers for sphinx, it requires the modules in set small
ipython_create_profile   creates a ipython profile
ipython_update_profile   update the profile with custom settings (file filters)
is_64bit   tells if the python is 64 bit or not
is_conda_distribution   Tells if it is a conda distribution or not, check the presence of Continuum Analytics or |Anaconda
is_installed   Tells if a module is installed or not.
is_package_installed   not very accurate but it should speed up the process
is_program_installed   Return program absolute path if installed in PATH Otherwise, return None
is_step_done   checks a file was written with function mark_step()
is_travis_or_appveyor   tells if is a travis environment or appveyor
julia_run_script   run a script on Julia
main   calls function missing_dependencies() but is meant to be added to scripts folder, parse command line arguments …
main   calls function install_all() but is meant to be added to scripts folder, parse command line arguments
main   calls function update_all() but is meant to be added to scripts folder, parse command line arguments
main   calls function update_all() but is meant to be added to scripts folder, parse command line arguments
main    
mark_step   create a file to remember was done (running it again takes times)
minimal_set   list of modules to add to python to get a minimal python
missing_dependencies   Returns the list of missing dependencies for the installed modules.
ml_set   modules introduced by students or needed for student projects
modify_scite_properties   modifies the scite properties
module_as_table   Returns a list of dictionaries or a dataframe for a list of modules.
name_sets_dataframe   returns a RST tables which described all the available sets
noLOG    
numeric_version   convert a string into a tuple with numbers wherever possible
open_tool_on_browser   open a page on browser for a specific tool
orange_set   modules implemented for Orange, it requires the modules in set ml
patch_julia03   patch absolute path in packages such as Julia/ZMQ or Julia/Nettle.
patch_shebang_line   Remove absolute path to python.exe in shebang lines.
patch_sourcefile   Replace a string in a source file
patch_sourcelines   Replace the middle of lines between in_line_start and endline
pyensae_set   list of modules needed to run unit test of module pyensae
pyquickhelper_set   list of modules needed to run unit test of module pyquickhelper
python_query   Execute Python command using the Python interpreter located in path
python_version   Retrieves the platform and version of this python.
pywin32_set   list of modules to add to python to get python with pywin32
r_run_script   run a script on R
read_page_wheel   read a cached HTML page
register   Register a Python distribution in Windows registry
reorder_module_list   reorder a list of modules to install, a module at position p should not depend not module at position p+1
run_checkings   create a batch file to update all packages
run_cmd   Runs a command line and waits for the results, run_cmd_private().
run_cmd_old   run a command line and wait for the result
run_cmd_path   run a script knowing python path, it does not raise an exception.
run_cmd_private   run a command line and wait for the result
run_innosetup   run InnotSetup for a script
run_venv_script   run a script on a virtual environment (the script should be simple
save_page_wheel   cache a HTML page
scraping_set   modules which help scraping the web, it requires the modules in set small
set_env   Set HKCU/HKLM environment variables
setup_ipython   The function applies the modification suggested in this blog post: Travailler avec IPython notebook
skip_run_cmd   has the same signature as run_cmd() but does nothing
small_set   list of modules to work with pandas, numpy, ipython, …
sphinx_theme_set   list of sphinx themes, it requires the modules in set small
split_cmp_command   splits a command line
suffix   add a suffix to a shortcut name = python version + architecture
switch_to_VS_compiler   applies fix described in Build a Python 64 bit extension on Windows 8
switch_to_mingw_compiler   applies a fix to use MinGW to compile extensions (does not work with Jupyter)
teachings_set   modules implemented for my teachings, it requires the modules in set ml
unzip7_files   If 7z is installed, the function uses it to uncompress file into 7z format. The file filename_7z
unzip_files   Unzip files from a zip archive.
update_all   Updates modules in list_module if None, this list will be returned by ensae_fullset(), the function starts …
update_all_packages   create a batch file to update all packages
update_module   Updates modules in list_module if None, this list will be returned by ensae_fullset(), the function starts …
update_pip   Updates pip for a specific distribution.
venv_install   install a package or a list of packages in a virtual environment
version_consensus   v1 and v2 are two versions of the same module, which one to keep?
where_in_path   Looks for a file in current directory and in every path in PATH.
win_check_installation   create a batch file to check the installation when well
win_download   The function downloads everything needed to prepare a setup.
win_download_notebooks   download notebooks and store them as documentation
win_install   Install setups
win_install_julia_step   does necessary steps to setup Julia
win_install_kernels   create a batch file to install kernels
win_install_package_other_python   Install a package for another Python distribution than the current one.
win_install_packages_other_python   Install all packages for another Python distribution where package could be found in a folder
win_install_r_step   does necessary steps to setup R
win_patch_paths   Paths are absolute when they are installed in all scripts .exe, we replaced them either by an empty string (path_to_python == "") …
win_python_setup   Prepares a Windows distribution of Python based on InnoSetup, inspired from WinPython but more easier to tweak I hope. …
win_replace_shebang   create a batch file to replace the shebang
windows_default_tools_list   returns a list of tools to install
windows_startup   Installs many tools. It does not work with Python 2.7.