Revamp the developer guide
Merge request reports
Activity
added 1 commit
- 2c6c5810 - [doc] keep going .. started editing the C++ stuff
assigned to @andre.anjos
added 1 commit
- 53c17900 - Update the instructions for getting the examples
@heusch @andre.anjos sometimes you need to download the .sql3 file after you install the db package: both for development and usage.
Where do you think this should be documented? Also, we can include the extra files in their conda package as well because we don't have any size limitation.
added 4 commits
Toggle commit listAlright, I think that this is almost done !
@amohammadi @andre.anjos I'll let you review this
There are still two "todos" and I think I'll let you deal with these ... he section on conda recipe is still to be done, and I think that @amohammadi will be better than me at this
Also, it could be nice if @onikisins and @vkrivokuca have a look on it, and this guide is more or less clear !38 (merged)
@amohammadi I'll let you merge this once you're happy with it
assigned to @amohammadi
assigned to @heusch
@heusch the tarballs are necessary for unit tests
- Resolved by Guillaume HEUSCH
- Resolved by Guillaume HEUSCH
- Resolved by Guillaume HEUSCH
- Resolved by Guillaume HEUSCH
- doc/pure_python.rst 0 → 100644
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. 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 ...
- Resolved by Guillaume HEUSCH
- Resolved by Guillaume HEUSCH
- doc/pure_python.rst 0 → 100644
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``. - Resolved by Guillaume HEUSCH
- Resolved by Guillaume HEUSCH
- Resolved by Guillaume HEUSCH
- Resolved by Guillaume HEUSCH
- Resolved by Guillaume HEUSCH
- Resolved by Guillaume HEUSCH
- Resolved by Guillaume HEUSCH
I think this developer guide has too redundant and probably old instructions compared to here: https://packaging.python.org/
changed milestone to %Bob 2.7.x release
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
Toggle commit list-
64eaf1de...92814edd - 4 commits from branch
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
Toggle commit listAlright, I finally edited (most of) what Andre suggested. Two points remain though:
- a possible more detailed explanation on mr.developer usage (see my comment above)
- the blank space in the nested list here https://gitlab.idiap.ch/bob/bob.extension/blob/may-2017-hackathon/doc/pure_python.rst#L244
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)
added 1 commit
- 75ddf924 - [doc] fixed issue 37 - documenting the naming of the scripts inside the packages…
added 1 commit
- ea19e004 - [nosetest] fixed new scripts name in test units
enabled an automatic merge when the pipeline for ea19e004 succeeds
mentioned in commit 215739b6