如何修改/编辑已安装的 anaconda 包

Question

I have some issues with a published package and wish to edit the code myself (may generate a pull request later to contribute). I am quite confused about how to do this since it seems there is a lack of step-by-step guidance. Could anybody give me a very detailed instruction about how this is done (or a link)? My understanding and also my questions about the workflow are:

1. Fork the package through git/github and have a local synced copy (done!).
2. Create a new Anaconda environment (done!)?
3. Install the package as normal: $conda install xxx or $python setup.py develop?
4. Do I make changes to the package directly in the package folder in Anaconda if I use python setup.py develop?
5. Or make changes to the local forked copy and install/update again and what are the commands for this?
6. Do I need to update the setup.py file as well before running it either way?

Answer 1

You can simply git-clone the package repo to your local computer and then install it in " development " or " editable " mode. This way you can easily make changes to the code while at the same time incorporating it into your own projects. Of course, this will also allow you to create pull requests later on.

Using Anaconda (or Miniconda) you have 2 equivalent options for this:

1. using conda ( conda-develop ):

conda develop <path_to_local_repo>

2. using pip ( pip install options )

pip install --editable <path_to_local_repo>

What these commands basically do is creating a link to the local repo-folder inside the environments site-packages folder.

Note that for " editable " pip installs you need aa basic setup.py :

import setuptools
setuptools.setup(name=<anything>)

On the other hand the conda develop <path_to_local_repo> command unfortunately doesn't work in environment.yml files.