Functions

function class parent truncated documentation
IsJuliaInstalled    
IsPandocInstalled    
IsRInstalled    
IsSQLiteSpyInstalled   check if SQLiteSpy was already installed
IsSciteInstalled   check if Scite was already installed
_build_reverse_index   builds a reverse index of the module,
_get_pypi_version_memoize    
_is_package_in_list   determines of this package is the one for the given module_name
_setup_hook   does nothing
add_kernel_ipython   add a kernel to jupyter
add_shortcut   Add a shortcut to the desktop.
add_shortcut_to_desktop  
func:
add_shortcut_to_desktop_for_ipython   create a shortcut on your desktop
add_shortcut_to_desktop_for_module   add 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
azure_set   Modules to handle huge datasets on disk, hierarchical datasets.
bootstrap   Import pip so we can use it to install pip and maybe setuptools too
build_requirements   builds a requirements list based on a list of :class:
build_venv_cmd   builds the command line for virtual env
check   Checks the library is working. It raises an exception. If you want to disable the logs:
clean_msi   clean all files follwing a specific pattern
copy_icons   copy all files from src to dest
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_ipython_console   create a batch file to start ipython
create_win_ipython_notebook   create a batch file to start ipython
create_win_ipython_qtconsole   create a batch file to start ipython QtConsole
create_win_julia_console   create a batch file to start ipython
create_win_python_console   create a batch file to start ipython
create_win_r_console   create a batch file to start ipython
create_win_r_gui   create a batch file to start ipython
create_win_rodeo   create a batch file to start ipython
create_win_rss   create a batch file to start ipython
create_win_scite   create a batch file to start ipython
create_win_spyder   create a batch file to start ipython
create_win_sqllitespy   create a batch file to start ipython
decode_fs_string   Convert string from file system charset to unicode
do_script   Execute a script (get-pip typically)
download_file   download a file from a url, the function does not download the file again if outfile already exists
download_from_sourceforge   download a file from a url using redirection, the function does not download the file again if outfile already ...
download_revealjs   Download
dtnow   shortcut, return
ensae_fullset  
ensae_set  
exec_shell_cmd   Execute shell command (args is a list of arguments) in path
extended_set   returns a list of modules to install, an rich set to work with data and more
extract_archive   Extract .zip, .exe (considered to be a zip archive) or .tar.gz archive to a temporary directory (if targetdir is ...
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 ...
get_R_version   returns the version of installed R, we only focus on the x64 version
get_env   Return HKCU/HKLM environment variable name and value
get_file_modification_date   get the date modification for a time
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_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_modules_version   return a dictionary { module:version }
get_package_description   returns the description of an R package as a dictionary
get_pip_program   get pip executable + fix an issue with PANDOC
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_r_version   Return version of the R installed in path
get_rodeo_version   Return version of the Rodeo 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
has_pip   tells if pip is installed
helper    
import_pywin32   For the module
inno_install_kernels   install kernels for IPython notebooks
innosetup_replacements   run InnotSetup for a script
install_7z   Install
install_R   Install
install_all   install modules in list_module if None, this list will be returned by :func:
install_julia   Install
install_kernels   install available kernels on Windows
install_mathjax   install a local copy of mathjax
install_memoize    
install_mingw   install
install_pandoc   Install
install_python   Install
install_scite   install
install_sqlitespy   Install
install_vs   install
ipython_create_profile   creates a ipython profile
ipython_update_profile   update the profile with custom settings (file filters)
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 :func:
julia_run_script   run a script on Julia
main   main function, installs pip
mark_step   create a file to remember was done (running it again takes times)
minimal_set   returns a list of modules to add to python to get a minimal python
modify_scite_properties   modifies the scite properties
module_as_table   returns a list of dictionaries or a dataframe for a list of modules
noLOG    
open_tool_on_browser   open a page on browser for a specific tool
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
python_query   Execute Python command using the Python interpreter located in path
python_version   retrieve the platform and version of this python
r_run_script   run a script on R
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_cmd   run a command line and wait for the result
run_innosetup   run InnotSetup for a script
run_venv_script   run a script on a vritual environment (the script should be simple
set_env   Set HKCU/HKLM environment variables
setup_ipython   The function applies the modification suggested in this blog post:
small_set   returns a list of modules to work with pandas, numpy, ipython, ...
sphinx_theme_set   list of sphinx themes
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
switch_to_mingw_compiler   applies a fix to use MinGW to compile extensions (does not work with IPython)
teachings_set  
unzip_files   unzip files from a zip archive
update_all   update modules in list_module if None, this list will be returned by :func:
update_all_packages   create a batch file to start ipython
update_pip   update pip for a specific distribution
venv_install   install a package or a list of packages in a virtual environment
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 start ipython
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   path are absolute when they are installed, see
win_python_setup   Prepares a Windows distribution of Python based on InnoSetup, inspired from WinPython but more easier to tweak I ...
win_replace_shebang   create a batch file to start ipython