{"id":1799,"date":"2019-05-07T16:24:02","date_gmt":"2019-05-07T14:24:02","guid":{"rendered":"https:\/\/iww.inria.fr\/sed-sophia\/?p=1799"},"modified":"2019-05-07T16:24:02","modified_gmt":"2019-05-07T14:24:02","slug":"a-hello-world-python-repository","status":"publish","type":"post","link":"https:\/\/iww.inria.fr\/sed-sophia\/a-hello-world-python-repository\/","title":{"rendered":"A Hello World Python Repository"},"content":{"rendered":"

<\/p>\n

python-hello_world<\/h1>\n

This repository<\/a> contains an example of a minimal Python package.
\nThe setup.py<\/code> file is central, it uses setuptools to package the python code.
\nIn the following we consider that a Conda environment has been created and activated.
\nYou can for instance use the development environment described in the conda\/environment.yaml<\/code> file.
\nTo do so, type the following command line<\/p>\n

conda env create -f conda\/environment.yaml<\/code><\/pre>\n
To create a Python package that can be used in this environment, three options are possible:<\/p>\n
    \n
  1. A develop mode.
    \nUsing this mode, all local modifications of source code will be considered in your Python interpreter (when restarted) without any post-installation.
    \nThis is particularly useful when adding new features.
    \nTo install this package in develop mode, type the following command line<\/li>\n<\/ol>\n
    python setup.py develop --prefix=${CONDA_PREFIX}<\/code><\/pre>\n
    Once this step is done, type the following command line for running tests<\/p>\n
    nosetests test -x -s -v<\/code><\/pre>\n
    Note that this require to have installed nose<\/code> in your environment.<\/p>\n
      \n
    1. An install mode.
      \nUsing this mode, all local modifications of source code will NOT<\/strong> be considered in your Python interpreter (when restarted).
      \nTo consider your local modifications of source code, you must install the package once again.
      \nThis is particularly useful when you want to install a stable version in one Conda environment while creating another environment for using the develop mode.
      \nTo install this package in develop mode, type the following command line<\/li>\n<\/ol>\n
      python setup.py install --prefix=${CONDA_PREFIX}<\/code><\/pre>\n
        \n
      1. A release mode.
        \nUsing the mode, a Conda package will be created from the install mode and can be distributed with Conda.
        \nTo build this package with Conda (with conda-build<\/code> installed), type the following command line<\/li>\n<\/ol>\n
        conda build conda\/recipe -c defaults --override-channels<\/code><\/pre>\n
        Then, you can upload the generated package or just install it.
        \nTo install this conda package, type the following command line<\/p>\n
        conda install python-hello_world -c local -c defaults --override-channels<\/code><\/pre>\n
        With the previous modes, the Conda environment doesn’t know that this python package has been installed.
        \nBut with this method, the python-hello_world<\/code> will appear in your Conda package listing.<\/p>\n
        Once the package is installed, it can be used from the Python interpreter with namespaces defined by your directories containing __init__.py<\/code> files.
        \nHere, we can print the \"Hello World\"<\/code> message using the following commands in the Python interpreter<\/p>\n
        import hello_world\n\nhello_world.func()<\/code><\/pre>\n
        Moreover, in the hello_world\/cli.py<\/code> we use the argparse<\/code> Python module to define command line tools declared both in the setup.py<\/code> and the meta.yaml<\/code> of the Conda recipe (entry points).
        \nSo whatever the mode chosen, to display this message you could also type in your terminal<\/p>\n
        hello_world<\/code><\/pre>\n
        <\/p>","protected":false},"excerpt":{"rendered":"
        python-hello_world This repository contains an example of a minimal Python package. The setup.py file is central, it uses setuptools to package the python code. In the following we consider that a Conda environment has been created and activated. You can for instance use the development environment described in the conda\/environment.yaml\u2026<\/p>\n
         Continue reading<\/span><\/i><\/a> <\/p>\n","protected":false},"author":2253,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":"","_members_access_role":[],"_members_access_error":""},"categories":[29,28],"tags":[117,61],"class_list":["post-1799","post","type-post","status-publish","format-standard","hentry","category-development-in-the-inria-teams","category-goodpractices","tag-conda","tag-python"],"_links":{"self":[{"href":"https:\/\/iww.inria.fr\/sed-sophia\/wp-json\/wp\/v2\/posts\/1799","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/iww.inria.fr\/sed-sophia\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/iww.inria.fr\/sed-sophia\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/iww.inria.fr\/sed-sophia\/wp-json\/wp\/v2\/users\/2253"}],"replies":[{"embeddable":true,"href":"https:\/\/iww.inria.fr\/sed-sophia\/wp-json\/wp\/v2\/comments?post=1799"}],"version-history":[{"count":7,"href":"https:\/\/iww.inria.fr\/sed-sophia\/wp-json\/wp\/v2\/posts\/1799\/revisions"}],"predecessor-version":[{"id":1806,"href":"https:\/\/iww.inria.fr\/sed-sophia\/wp-json\/wp\/v2\/posts\/1799\/revisions\/1806"}],"wp:attachment":[{"href":"https:\/\/iww.inria.fr\/sed-sophia\/wp-json\/wp\/v2\/media?parent=1799"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/iww.inria.fr\/sed-sophia\/wp-json\/wp\/v2\/categories?post=1799"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/iww.inria.fr\/sed-sophia\/wp-json\/wp\/v2\/tags?post=1799"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}