legacy python lib see xsthunder/python-lib: useful python pieces of code
code and release
-
code at xsthunder/xs_lib at master
-
merge to releae and travis will deploy to pip
TODO
Features
- Full test with traivis to make sure things are on rail.
-
xs_lib.ismain.main(__name__, main)
to define entrance -
xs_lib.common.IN_TRAVIS
andxs_lib.common.IN_JUPYTER
to tell current state, also allow bash env setting totrue
orfalse
to overwrite. -
xs_lib.common.CLI_TEST
is read from bash env to control cli.
Install and Run
xs-lib · PyPI
Install viapip install xs-lib
Use in Code
ipynb
file
use for single export the ipynb
file
import xs_lib.common as common
# this will choose con tqdm
for i in common.tqdm(range(3)):
print(i)
nbe = common.NBExporter()
nbe('./pdb.ipynb', to='./')
use for projcet
clone xsthunder/jupyter_dev_template
Use in cli
nb2py --help
optional pakage tqdm
conda install tqdm
Usage suggestion
add #test_export
to top of the code cell which will be exported to test and standard file.
add #export
to top ot the code cell which will be exported to standard file.
use Sure 1.4.7 - Documentation — sure 1.4.7 documentation for #test_export
.
Development
Environment Setup
bash ./config/create-env.sh
for conda
deps
- not all deps are necessary. only ipython are set in the
setup.py/deps
. -
xs_lib.common
supports dynamic import. feel free to import. - to import other modules, please install corresponding deps first or you may come across import error.
- It's recommanded to install all packages listed in create-env.sh
code structures
Ref
Packaging Python Projects — Python Packaging User Guide
notebook2script
from course-v3/nbs/dl2 at master · fastai/course-v3