Skip to content
Snippets Groups Projects

Revamp the developer guide

Merged Amir MOHAMMADI requested to merge may-2017-hackathon into master
2 unresolved threads

Merge request reports

Loading
Loading

Activity

Filter activity
  • Approvals
  • Assignees & reviewers
  • Comments (from bots)
  • Comments (from users)
  • Commits & branches
  • Edits
  • Labels
  • Lock status
  • Mentions
  • Merge request status
  • Tracking
  • André Anjos
  • 169 2. It populated the ``./bin`` directory with all the ``console_scripts`` that you have specified in the ``setup.py``.
    170 In our example, this is ``./bin/version.py``.
    171
    172 .. note::
    173
    174 One thing to note in package development is that when you
    175 change the entry points in ``setup.py`` of a package, you need to
    176 run ``buildout`` again.
    177
    178
    179 Using mr.developer
    180 ==================
    181
    182 One extension that may be useful is `mr.developer`_. It allows to develop *other packages* alongside your "main" package.
    183 This extension will allow buildout to automatically check out packages from git repositories, and places them into the ``./src`` directory.
    184 It can be simply set up by adding ``mr.developer`` to the extensions section.
    • Maybe we should say somewhere this is required seldomly.

    • Hmm ... actually, this is not required at all. The way I see it is more as an option. And if people want to deal with this, we let them figure it out ;)

    • Of all, we're mostly doing this for ourselves. In order to have the procedure required to do it documented, we better leave it or we'll have to explain this over and over when needed.

    • IMHO, I think that what is explained here is sufficient (plus there is a list to the mr developer documentation). At least, you get the idea that another package will be develop and that you can modify it as well, and that the modification will be taken into account in your environment.

      No, I honestly don't know what should/could be explained in more details here ...

    • Please register or sign in to reply
  • 212 Again, mr.developer does not automatically place the packages into the ``develop`` list (and neither in the ``eggs``), so you have to do that yourself.
    213
    214 With this augmented ``buidlout.cfg``, the ``buildout`` command will perform the following steps:
    215
    216 1. It checks out the packages that you specified using ``mr.developer``.
    217
    218 2. It develops all packages in the ``develop`` section
    219 (it links the source of the packages to your local environment).
    220
    221 3. It will go through the list of ``eggs`` and search for according packages in the following order:
    222
    223 #. In one of the already developed directories.
    224 #. In the python environment, e.g., packages installed with ``pip``.
    225 #. Online, i.e., in the ``find-links`` directory, or by default on PyPI_.
    226
    227 4. It will populate the ``./bin`` directory with all the ``console_scripts`` that you have specified in the ``setup.py``.
  • André Anjos
  • Amir MOHAMMADI added 1 commit

    added 1 commit

    Compare with previous version

  • I think this developer guide has too redundant and probably old instructions compared to here: https://packaging.python.org/

  • I uploaded a draft of conda docs.

  • Amir MOHAMMADI added 1 commit

    added 1 commit

    Compare with previous version

  • Amir MOHAMMADI added 2 commits

    added 2 commits

    • 40ca7440 - Update the docs to reflect conda usage
    • 64eaf1de - put the tarballs back for the tests to pass

    Compare with previous version

  • changed milestone to %Bob 2.7.x release

  • Guillaume HEUSCH added 14 commits

    added 14 commits

    • 64eaf1de...92814edd - 4 commits from branch master
    • 1563832d - [bob.example.project] remove bootstrap-buildout.py
    • 23c2efc0 - [bob.example.project] removed bootstap-buildout.py from the example package
    • e2d0ffcc - [doc] reorganize the doc, especially the user guide to bob package development
    • 65718155 - [doc] keep going .. started editing the C++ stuff
    • e4aad851 - [doc] fixed stuff in C++/Python
    • 9d64fbe3 - Update the instructions for getting the examples
    • ca0daf12 - [doc] user guide should be ok up to additional concerns ...
    • 1c2d05a7 - [doc] almost finished the revamping of the doc !
    • dcdd040f - [doc] updated command line to get example packages, and removed the tarballs
    • 350bca27 - [doc] fixed two first suggestions by Andre

    Compare with previous version

  • Guillaume HEUSCH added 4 commits

    added 4 commits

    • ed764094 - [nosetests] changed the test_extension.py script to get rid of tarballs and usin…
    • 09dff8e7 - [doc] fixed (most of) Andre's comment in python package development
    • 36ef3876 - [doc] fixed Andre's comment in Python/C++ package development
    • e3abc927 - [doc] fixed Andre's comment in additional information

    Compare with previous version

  • Alright, I finally edited (most of) what Andre suggested. Two points remain though:

    I pushed everything to this branch (i.e. may-2017-hackathon) ... And I don't plan to touch it anymore !

    @andre.anjos , @amohammadi feel free to do whatever is required to move foward with this Thanks

  • Well, not really the case, I'm currently tackling this: #37 (closed)

    So hold your horses ...

  • mentioned in issue #37 (closed)

  • Alright, done !

  • added 1 commit

    • 75ddf924 - [doc] fixed issue 37 - documenting the naming of the scripts inside the packages…

    Compare with previous version

  • added 1 commit

    • ea19e004 - [nosetest] fixed new scripts name in test units

    Compare with previous version

  • Ok - as soon as the build passes, we'll merge this branch.

    Thanks for your work.

  • André Anjos unmarked as a Work In Progress

    unmarked as a Work In Progress

  • André Anjos enabled an automatic merge when the pipeline for ea19e004 succeeds

    enabled an automatic merge when the pipeline for ea19e004 succeeds

  • André Anjos mentioned in commit 215739b6

    mentioned in commit 215739b6

  • merged

  • Please register or sign in to reply
    Loading